MonitorSummary¶
- class oci.apm_synthetics.models.MonitorSummary(**kwargs)¶
Bases:
objectInformation about the monitor.
Attributes:
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the monitor_type property of a MonitorSummary.
A constant which can be used with the scheduling_policy property of a MonitorSummary.
A constant which can be used with the scheduling_policy property of a MonitorSummary.
A constant which can be used with the scheduling_policy property of a MonitorSummary.
A constant which can be used with the status property of a MonitorSummary.
A constant which can be used with the status property of a MonitorSummary.
A constant which can be used with the status property of a MonitorSummary.
[Required] Gets the batch_interval_in_seconds of this MonitorSummary.
Gets the configuration of this MonitorSummary.
Gets the created_by of this MonitorSummary.
Gets the defined_tags of this MonitorSummary.
[Required] Gets the display_name of this MonitorSummary.
Gets the freeform_tags of this MonitorSummary.
[Required] Gets the id of this MonitorSummary.
Gets the is_i_pv6 of this MonitorSummary.
[Required] Gets the is_run_now of this MonitorSummary.
[Required] Gets the is_run_once of this MonitorSummary.
Gets the last_updated_by of this MonitorSummary.
Gets the maintenance_window_schedule of this MonitorSummary.
[Required] Gets the monitor_type of this MonitorSummary.
[Required] Gets the repeat_interval_in_seconds of this MonitorSummary.
[Required] Gets the scheduling_policy of this MonitorSummary.
[Required] Gets the script_id of this MonitorSummary.
[Required] Gets the script_name of this MonitorSummary.
[Required] Gets the status of this MonitorSummary.
Gets the target of this MonitorSummary.
Gets the time_created of this MonitorSummary.
Gets the time_updated of this MonitorSummary.
[Required] Gets the timeout_in_seconds of this MonitorSummary.
[Required] Gets the vantage_point_count of this MonitorSummary.
[Required] Gets the vantage_points of this MonitorSummary.
Methods:
__init__(**kwargs)Initializes a new MonitorSummary object with values from keyword arguments.
- MONITOR_TYPE_BROWSER = 'BROWSER'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “BROWSER”
- MONITOR_TYPE_DNS = 'DNS'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “DNS”
- MONITOR_TYPE_FTP = 'FTP'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “FTP”
- MONITOR_TYPE_NETWORK = 'NETWORK'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “NETWORK”
- MONITOR_TYPE_REST = 'REST'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “REST”
- MONITOR_TYPE_SCRIPTED_BROWSER = 'SCRIPTED_BROWSER'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “SCRIPTED_BROWSER”
- MONITOR_TYPE_SCRIPTED_REST = 'SCRIPTED_REST'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “SCRIPTED_REST”
- MONITOR_TYPE_SQL = 'SQL'¶
A constant which can be used with the monitor_type property of a MonitorSummary. This constant has a value of “SQL”
- SCHEDULING_POLICY_ALL = 'ALL'¶
A constant which can be used with the scheduling_policy property of a MonitorSummary. This constant has a value of “ALL”
- SCHEDULING_POLICY_BATCHED_ROUND_ROBIN = 'BATCHED_ROUND_ROBIN'¶
A constant which can be used with the scheduling_policy property of a MonitorSummary. This constant has a value of “BATCHED_ROUND_ROBIN”
- SCHEDULING_POLICY_ROUND_ROBIN = 'ROUND_ROBIN'¶
A constant which can be used with the scheduling_policy property of a MonitorSummary. This constant has a value of “ROUND_ROBIN”
- STATUS_DISABLED = 'DISABLED'¶
A constant which can be used with the status property of a MonitorSummary. This constant has a value of “DISABLED”
- STATUS_ENABLED = 'ENABLED'¶
A constant which can be used with the status property of a MonitorSummary. This constant has a value of “ENABLED”
- STATUS_INVALID = 'INVALID'¶
A constant which can be used with the status property of a MonitorSummary. This constant has a value of “INVALID”
- __init__(**kwargs)¶
Initializes a new MonitorSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this MonitorSummary.
display_name (str) – The value to assign to the display_name property of this MonitorSummary.
monitor_type (str) – The value to assign to the monitor_type property of this MonitorSummary. Allowed values for this property are: “SCRIPTED_BROWSER”, “BROWSER”, “SCRIPTED_REST”, “REST”, “NETWORK”, “DNS”, “FTP”, “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
vantage_points (list[oci.apm_synthetics.models.VantagePointInfo]) – The value to assign to the vantage_points property of this MonitorSummary.
vantage_point_count (int) – The value to assign to the vantage_point_count property of this MonitorSummary.
script_id (str) – The value to assign to the script_id property of this MonitorSummary.
script_name (str) – The value to assign to the script_name property of this MonitorSummary.
status (str) – The value to assign to the status property of this MonitorSummary. Allowed values for this property are: “ENABLED”, “DISABLED”, “INVALID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
repeat_interval_in_seconds (int) – The value to assign to the repeat_interval_in_seconds property of this MonitorSummary.
is_run_once (bool) – The value to assign to the is_run_once property of this MonitorSummary.
timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this MonitorSummary.
target (str) – The value to assign to the target property of this MonitorSummary.
configuration (oci.apm_synthetics.models.MonitorConfiguration) – The value to assign to the configuration property of this MonitorSummary.
maintenance_window_schedule (oci.apm_synthetics.models.MaintenanceWindowSchedule) – The value to assign to the maintenance_window_schedule property of this MonitorSummary.
time_created (datetime) – The value to assign to the time_created property of this MonitorSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MonitorSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MonitorSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MonitorSummary.
is_run_now (bool) – The value to assign to the is_run_now property of this MonitorSummary.
scheduling_policy (str) – The value to assign to the scheduling_policy property of this MonitorSummary. Allowed values for this property are: “ALL”, “ROUND_ROBIN”, “BATCHED_ROUND_ROBIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
batch_interval_in_seconds (int) – The value to assign to the batch_interval_in_seconds property of this MonitorSummary.
is_i_pv6 (bool) – The value to assign to the is_i_pv6 property of this MonitorSummary.
created_by (str) – The value to assign to the created_by property of this MonitorSummary.
last_updated_by (str) – The value to assign to the last_updated_by property of this MonitorSummary.
- property batch_interval_in_seconds¶
[Required] Gets the batch_interval_in_seconds of this MonitorSummary. Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Returns
The batch_interval_in_seconds of this MonitorSummary.
- Return type
int
- property configuration¶
Gets the configuration of this MonitorSummary.
- Returns
The configuration of this MonitorSummary.
- Return type
- property created_by¶
Gets the created_by of this MonitorSummary. Name of the user that created the monitor.
- Returns
The created_by of this MonitorSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this MonitorSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this MonitorSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this MonitorSummary. Unique name that can be edited. The name should not contain any confidential information.
- Returns
The display_name of this MonitorSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this MonitorSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this MonitorSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this MonitorSummary. The OCID of the monitor.
- Returns
The id of this MonitorSummary.
- Return type
str
- property is_i_pv6¶
Gets the is_i_pv6 of this MonitorSummary. If enabled, domain name will resolve to an IPv6 address.
- Returns
The is_i_pv6 of this MonitorSummary.
- Return type
bool
- property is_run_now¶
[Required] Gets the is_run_now of this MonitorSummary. If isRunNow is enabled, then the monitor will run immediately.
- Returns
The is_run_now of this MonitorSummary.
- Return type
bool
- property is_run_once¶
[Required] Gets the is_run_once of this MonitorSummary. If runOnce is enabled, then the monitor will run once.
- Returns
The is_run_once of this MonitorSummary.
- Return type
bool
- property last_updated_by¶
Gets the last_updated_by of this MonitorSummary. Name of the user that recently updated the monitor.
- Returns
The last_updated_by of this MonitorSummary.
- Return type
str
- property maintenance_window_schedule¶
Gets the maintenance_window_schedule of this MonitorSummary.
- Returns
The maintenance_window_schedule of this MonitorSummary.
- Return type
- property monitor_type¶
[Required] Gets the monitor_type of this MonitorSummary. The type of monitor.
Allowed values for this property are: “SCRIPTED_BROWSER”, “BROWSER”, “SCRIPTED_REST”, “REST”, “NETWORK”, “DNS”, “FTP”, “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The monitor_type of this MonitorSummary.
- Return type
str
- property repeat_interval_in_seconds¶
[Required] Gets the repeat_interval_in_seconds of this MonitorSummary. Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- Returns
The repeat_interval_in_seconds of this MonitorSummary.
- Return type
int
- property scheduling_policy¶
[Required] Gets the scheduling_policy of this MonitorSummary. Scheduling policy to decide the distribution of monitor executions on vantage points.
Allowed values for this property are: “ALL”, “ROUND_ROBIN”, “BATCHED_ROUND_ROBIN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The scheduling_policy of this MonitorSummary.
- Return type
str
- property script_id¶
[Required] Gets the script_id of this MonitorSummary. The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- Returns
The script_id of this MonitorSummary.
- Return type
str
- property script_name¶
[Required] Gets the script_name of this MonitorSummary. Name of the script.
- Returns
The script_name of this MonitorSummary.
- Return type
str
- property status¶
[Required] Gets the status of this MonitorSummary. Enables or disables the monitor.
Allowed values for this property are: “ENABLED”, “DISABLED”, “INVALID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this MonitorSummary.
- Return type
str
- property target¶
Gets the target of this MonitorSummary. Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- Returns
The target of this MonitorSummary.
- Return type
str
- property time_created¶
Gets the time_created of this MonitorSummary. The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- Returns
The time_created of this MonitorSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this MonitorSummary. The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- Returns
The time_updated of this MonitorSummary.
- Return type
datetime
- property timeout_in_seconds¶
[Required] Gets the timeout_in_seconds of this MonitorSummary. Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- Returns
The timeout_in_seconds of this MonitorSummary.
- Return type
int
- property vantage_point_count¶
[Required] Gets the vantage_point_count of this MonitorSummary. Number of vantage points where monitor is running.
- Returns
The vantage_point_count of this MonitorSummary.
- Return type
int
- property vantage_points¶
[Required] Gets the vantage_points of this MonitorSummary. List of public, dedicated and onPremise vantage points where the monitor is running.
- Returns
The vantage_points of this MonitorSummary.
- Return type