PingMonitorSummary

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

Bases: object

This model contains all of the mutable and immutable summary properties for an HTTP monitor.

Attributes

PROTOCOL_ICMP A constant which can be used with the protocol property of a PingMonitorSummary.
PROTOCOL_TCP A constant which can be used with the protocol property of a PingMonitorSummary.
compartment_id Gets the compartment_id of this PingMonitorSummary.
defined_tags Gets the defined_tags of this PingMonitorSummary.
display_name Gets the display_name of this PingMonitorSummary.
freeform_tags Gets the freeform_tags of this PingMonitorSummary.
home_region Gets the home_region of this PingMonitorSummary.
id Gets the id of this PingMonitorSummary.
interval_in_seconds Gets the interval_in_seconds of this PingMonitorSummary.
is_enabled Gets the is_enabled of this PingMonitorSummary.
protocol Gets the protocol of this PingMonitorSummary.
results_url Gets the results_url of this PingMonitorSummary.
time_created Gets the time_created of this PingMonitorSummary.

Methods

__init__(**kwargs) Initializes a new PingMonitorSummary object with values from keyword arguments.
PROTOCOL_ICMP = 'ICMP'

A constant which can be used with the protocol property of a PingMonitorSummary. This constant has a value of “ICMP”

PROTOCOL_TCP = 'TCP'

A constant which can be used with the protocol property of a PingMonitorSummary. This constant has a value of “TCP”

__init__(**kwargs)

Initializes a new PingMonitorSummary 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 PingMonitorSummary.
  • results_url (str) – The value to assign to the results_url property of this PingMonitorSummary.
  • home_region (str) – The value to assign to the home_region property of this PingMonitorSummary.
  • time_created (datetime) – The value to assign to the time_created property of this PingMonitorSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this PingMonitorSummary.
  • display_name (str) – The value to assign to the display_name property of this PingMonitorSummary.
  • interval_in_seconds (int) – The value to assign to the interval_in_seconds property of this PingMonitorSummary.
  • is_enabled (bool) – The value to assign to the is_enabled property of this PingMonitorSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PingMonitorSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PingMonitorSummary.
  • protocol (str) – The value to assign to the protocol property of this PingMonitorSummary. 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’.
compartment_id

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

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

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

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

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

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

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

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

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

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

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

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

Gets the is_enabled of this PingMonitorSummary. Enables or disables the monitor. Set to ‘true’ to launch monitoring.

Returns:The is_enabled of this PingMonitorSummary.
Return type:bool
protocol

Gets the protocol of this PingMonitorSummary. 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 PingMonitorSummary.
Return type:str
results_url

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

Returns:The results_url of this PingMonitorSummary.
Return type:str
time_created

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

Returns:The time_created of this PingMonitorSummary.
Return type:datetime