UpdateMonitorDetails

class oci.apm_synthetics.models.UpdateMonitorDetails(**kwargs)

Bases: object

Details of the request body used to update a monitor.

Attributes

STATUS_DISABLED A constant which can be used with the status property of a UpdateMonitorDetails.
STATUS_ENABLED A constant which can be used with the status property of a UpdateMonitorDetails.
STATUS_INVALID A constant which can be used with the status property of a UpdateMonitorDetails.
configuration Gets the configuration of this UpdateMonitorDetails.
defined_tags Gets the defined_tags of this UpdateMonitorDetails.
display_name Gets the display_name of this UpdateMonitorDetails.
freeform_tags Gets the freeform_tags of this UpdateMonitorDetails.
is_run_once Gets the is_run_once of this UpdateMonitorDetails.
repeat_interval_in_seconds Gets the repeat_interval_in_seconds of this UpdateMonitorDetails.
script_id Gets the script_id of this UpdateMonitorDetails.
script_parameters Gets the script_parameters of this UpdateMonitorDetails.
status Gets the status of this UpdateMonitorDetails.
target Gets the target of this UpdateMonitorDetails.
timeout_in_seconds Gets the timeout_in_seconds of this UpdateMonitorDetails.
vantage_points Gets the vantage_points of this UpdateMonitorDetails.

Methods

__init__(**kwargs) Initializes a new UpdateMonitorDetails object with values from keyword arguments.
STATUS_DISABLED = 'DISABLED'

A constant which can be used with the status property of a UpdateMonitorDetails. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'

A constant which can be used with the status property of a UpdateMonitorDetails. This constant has a value of “ENABLED”

STATUS_INVALID = 'INVALID'

A constant which can be used with the status property of a UpdateMonitorDetails. This constant has a value of “INVALID”

__init__(**kwargs)

Initializes a new UpdateMonitorDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this UpdateMonitorDetails.
  • vantage_points (list[str]) – The value to assign to the vantage_points property of this UpdateMonitorDetails.
  • script_id (str) – The value to assign to the script_id property of this UpdateMonitorDetails.
  • status (str) – The value to assign to the status property of this UpdateMonitorDetails. Allowed values for this property are: “ENABLED”, “DISABLED”, “INVALID”
  • repeat_interval_in_seconds (int) – The value to assign to the repeat_interval_in_seconds property of this UpdateMonitorDetails.
  • is_run_once (bool) – The value to assign to the is_run_once property of this UpdateMonitorDetails.
  • timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this UpdateMonitorDetails.
  • target (str) – The value to assign to the target property of this UpdateMonitorDetails.
  • script_parameters (list[oci.apm_synthetics.models.MonitorScriptParameter]) – The value to assign to the script_parameters property of this UpdateMonitorDetails.
  • configuration (oci.apm_synthetics.models.MonitorConfiguration) – The value to assign to the configuration property of this UpdateMonitorDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateMonitorDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateMonitorDetails.
configuration

Gets the configuration of this UpdateMonitorDetails.

Returns:The configuration of this UpdateMonitorDetails.
Return type:oci.apm_synthetics.models.MonitorConfiguration
defined_tags

Gets the defined_tags of this UpdateMonitorDetails. 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 UpdateMonitorDetails.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this UpdateMonitorDetails. Unique name that can be edited. The name should not contain any confidential information.

Returns:The display_name of this UpdateMonitorDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this UpdateMonitorDetails. 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 UpdateMonitorDetails.
Return type:dict(str, str)
is_run_once

Gets the is_run_once of this UpdateMonitorDetails. If runOnce is enabled, then the monitor will run once.

Returns:The is_run_once of this UpdateMonitorDetails.
Return type:bool
repeat_interval_in_seconds

Gets the repeat_interval_in_seconds of this UpdateMonitorDetails. Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

Returns:The repeat_interval_in_seconds of this UpdateMonitorDetails.
Return type:int
script_id

Gets the script_id of this UpdateMonitorDetails. 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 UpdateMonitorDetails.
Return type:str
script_parameters

Gets the script_parameters of this UpdateMonitorDetails. List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{“paramName”: “userid”, “paramValue”:”testuser”}]

Returns:The script_parameters of this UpdateMonitorDetails.
Return type:list[oci.apm_synthetics.models.MonitorScriptParameter]
status

Gets the status of this UpdateMonitorDetails. Enables or disables the monitor.

Allowed values for this property are: “ENABLED”, “DISABLED”, “INVALID”

Returns:The status of this UpdateMonitorDetails.
Return type:str
target

Gets the target of this UpdateMonitorDetails. Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

Returns:The target of this UpdateMonitorDetails.
Return type:str
timeout_in_seconds

Gets the timeout_in_seconds of this UpdateMonitorDetails. Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

Returns:The timeout_in_seconds of this UpdateMonitorDetails.
Return type:int
vantage_points

Gets the vantage_points of this UpdateMonitorDetails. A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

Returns:The vantage_points of this UpdateMonitorDetails.
Return type:list[str]