CreateMonitorDetails

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

Bases: object

Details of the request body used to create a new monitor.

Attributes

MONITOR_TYPE_BROWSER A constant which can be used with the monitor_type property of a CreateMonitorDetails.
MONITOR_TYPE_REST A constant which can be used with the monitor_type property of a CreateMonitorDetails.
MONITOR_TYPE_SCRIPTED_BROWSER A constant which can be used with the monitor_type property of a CreateMonitorDetails.
MONITOR_TYPE_SCRIPTED_REST A constant which can be used with the monitor_type property of a CreateMonitorDetails.
STATUS_DISABLED A constant which can be used with the status property of a CreateMonitorDetails.
STATUS_ENABLED A constant which can be used with the status property of a CreateMonitorDetails.
STATUS_INVALID A constant which can be used with the status property of a CreateMonitorDetails.
configuration Gets the configuration of this CreateMonitorDetails.
defined_tags Gets the defined_tags of this CreateMonitorDetails.
display_name [Required] Gets the display_name of this CreateMonitorDetails.
freeform_tags Gets the freeform_tags of this CreateMonitorDetails.
monitor_type [Required] Gets the monitor_type of this CreateMonitorDetails.
repeat_interval_in_seconds [Required] Gets the repeat_interval_in_seconds of this CreateMonitorDetails.
script_id Gets the script_id of this CreateMonitorDetails.
script_parameters Gets the script_parameters of this CreateMonitorDetails.
status Gets the status of this CreateMonitorDetails.
target Gets the target of this CreateMonitorDetails.
timeout_in_seconds Gets the timeout_in_seconds of this CreateMonitorDetails.
vantage_points [Required] Gets the vantage_points of this CreateMonitorDetails.

Methods

__init__(**kwargs) Initializes a new CreateMonitorDetails object with values from keyword arguments.
MONITOR_TYPE_BROWSER = 'BROWSER'

A constant which can be used with the monitor_type property of a CreateMonitorDetails. This constant has a value of “BROWSER”

MONITOR_TYPE_REST = 'REST'

A constant which can be used with the monitor_type property of a CreateMonitorDetails. 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 CreateMonitorDetails. 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 CreateMonitorDetails. This constant has a value of “SCRIPTED_REST”

STATUS_DISABLED = 'DISABLED'

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

STATUS_ENABLED = 'ENABLED'

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

STATUS_INVALID = 'INVALID'

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

__init__(**kwargs)

Initializes a new CreateMonitorDetails 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 CreateMonitorDetails.
  • monitor_type (str) – The value to assign to the monitor_type property of this CreateMonitorDetails. Allowed values for this property are: “SCRIPTED_BROWSER”, “BROWSER”, “SCRIPTED_REST”, “REST”
  • vantage_points (list[str]) – The value to assign to the vantage_points property of this CreateMonitorDetails.
  • script_id (str) – The value to assign to the script_id property of this CreateMonitorDetails.
  • status (str) – The value to assign to the status property of this CreateMonitorDetails. 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 CreateMonitorDetails.
  • timeout_in_seconds (int) – The value to assign to the timeout_in_seconds property of this CreateMonitorDetails.
  • target (str) – The value to assign to the target property of this CreateMonitorDetails.
  • script_parameters (list[oci.apm_synthetics.models.MonitorScriptParameter]) – The value to assign to the script_parameters property of this CreateMonitorDetails.
  • configuration (oci.apm_synthetics.models.MonitorConfiguration) – The value to assign to the configuration property of this CreateMonitorDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMonitorDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMonitorDetails.
configuration

Gets the configuration of this CreateMonitorDetails.

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

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

[Required] Gets the display_name of this CreateMonitorDetails. Unique name that can be edited. The name should not contain any confidential information.

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

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

[Required] Gets the monitor_type of this CreateMonitorDetails. Type of monitor.

Allowed values for this property are: “SCRIPTED_BROWSER”, “BROWSER”, “SCRIPTED_REST”, “REST”

Returns:The monitor_type of this CreateMonitorDetails.
Return type:str
repeat_interval_in_seconds

[Required] Gets the repeat_interval_in_seconds of this CreateMonitorDetails. 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 CreateMonitorDetails.
Return type:int
script_id

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

Gets the script_parameters of this CreateMonitorDetails. 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 CreateMonitorDetails.
Return type:list[oci.apm_synthetics.models.MonitorScriptParameter]
status

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

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

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

Gets the target of this CreateMonitorDetails. 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 CreateMonitorDetails.
Return type:str
timeout_in_seconds

Gets the timeout_in_seconds of this CreateMonitorDetails. 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 CreateMonitorDetails.
Return type:int
vantage_points

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

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