PingMonitor

class oci.healthchecks.models.PingMonitor(**kwargs)

Bases: object

A summary containing all of the mutable and immutable properties for a ping monitor.

PROTOCOL_ICMP = 'ICMP'

A constant which can be used with the protocol property of a PingMonitor. This constant has a value of "ICMP"

PROTOCOL_TCP = 'TCP'

A constant which can be used with the protocol property of a PingMonitor. This constant has a value of "TCP"

__init__(**kwargs)

Initializes a new PingMonitor 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 PingMonitor.
  • results_url (str) -- The value to assign to the results_url property of this PingMonitor.
  • home_region (str) -- The value to assign to the home_region property of this PingMonitor.
  • time_created (datetime) -- The value to assign to the time_created property of this PingMonitor.
  • compartment_id (str) -- The value to assign to the compartment_id property of this PingMonitor.
  • targets (list[str]) -- The value to assign to the targets property of this PingMonitor.
  • vantage_point_names (list[str]) -- The value to assign to the vantage_point_names property of this PingMonitor.
  • port (int) -- The value to assign to the port property of this PingMonitor.
  • timeout_in_seconds (int) -- The value to assign to the timeout_in_seconds property of this PingMonitor.
  • protocol (str) -- The value to assign to the protocol property of this PingMonitor. Allowed values for this property are: "ICMP", "TCP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • display_name (str) -- The value to assign to the display_name property of this PingMonitor.
  • interval_in_seconds (int) -- The value to assign to the interval_in_seconds property of this PingMonitor.
  • is_enabled (bool) -- The value to assign to the is_enabled property of this PingMonitor.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this PingMonitor.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this PingMonitor.
compartment_id

Gets the compartment_id of this PingMonitor. The OCID of the compartment.

Returns:The compartment_id of this PingMonitor.
Return type:str
defined_tags

Gets the defined_tags of this PingMonitor. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this PingMonitor.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this PingMonitor. A user-friendly and mutable name suitable for display in a user interface.

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

Gets the freeform_tags of this PingMonitor. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Returns:The freeform_tags of this PingMonitor.
Return type:dict(str, str)
home_region

Gets the home_region of this PingMonitor. The region where updates must be made and where results must be fetched from.

Returns:The home_region of this PingMonitor.
Return type:str
id

Gets the id of this PingMonitor. The OCID of the resource.

Returns:The id of this PingMonitor.
Return type:str
interval_in_seconds

Gets the interval_in_seconds of this PingMonitor. The monitor interval in seconds. Valid values: 10, 30, and 60.

Returns:The interval_in_seconds of this PingMonitor.
Return type:int
is_enabled

Gets the is_enabled of this PingMonitor. Enables or disables the monitor. Set to 'true' to launch monitoring.

Returns:The is_enabled of this PingMonitor.
Return type:bool
port

Gets the port of this PingMonitor. The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

Returns:The port of this PingMonitor.
Return type:int
protocol

Gets the protocol of this PingMonitor. Allowed values for this property are: "ICMP", "TCP", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The protocol of this PingMonitor.
Return type:str
results_url

Gets the results_url of this PingMonitor. A URL for fetching the probe results.

Returns:The results_url of this PingMonitor.
Return type:str
targets

Gets the targets of this PingMonitor. A list of targets (hostnames or IP addresses) of the probe.

Returns:The targets of this PingMonitor.
Return type:list[str]
time_created

Gets the time_created of this PingMonitor. The RFC 3339-formatted creation date and time of the probe.

Returns:The time_created of this PingMonitor.
Return type:datetime
timeout_in_seconds

Gets the timeout_in_seconds of this PingMonitor. The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.

Returns:The timeout_in_seconds of this PingMonitor.
Return type:int
vantage_point_names

Gets the vantage_point_names of this PingMonitor. A list of names of vantage points from which to execute the probe.

Returns:The vantage_point_names of this PingMonitor.
Return type:list[str]