PingProbe

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

Bases: object

This model contains all of the mutable and immutable properties for a ping probe.

PROTOCOL_ICMP = 'ICMP'

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

PROTOCOL_TCP = 'TCP'

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

__init__(**kwargs)

Initializes a new PingProbe 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 PingProbe.
  • results_url (str) -- The value to assign to the results_url property of this PingProbe.
  • home_region (str) -- The value to assign to the home_region property of this PingProbe.
  • time_created (datetime) -- The value to assign to the time_created property of this PingProbe.
  • compartment_id (str) -- The value to assign to the compartment_id property of this PingProbe.
  • targets (list[str]) -- The value to assign to the targets property of this PingProbe.
  • vantage_point_names (list[str]) -- The value to assign to the vantage_point_names property of this PingProbe.
  • port (int) -- The value to assign to the port property of this PingProbe.
  • timeout_in_seconds (int) -- The value to assign to the timeout_in_seconds property of this PingProbe.
  • protocol (str) -- The value to assign to the protocol property of this PingProbe. 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 PingProbe. The OCID of the compartment.

Returns:The compartment_id of this PingProbe.
Return type:str
home_region

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

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

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

Returns:The id of this PingProbe.
Return type:str
port

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

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

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

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

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

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

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

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

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

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

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

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