HealthCheckResult¶

class oci.load_balancer.models.HealthCheckResult(**kwargs)¶

Bases: object

Information about a single backend server health check result reported by a load balancer.

Attributes

`HEALTH_CHECK_STATUS_CONNECT_FAILED`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_INVALID_STATUS_CODE`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_IO_ERROR`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_OFFLINE`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_OK`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_REGEX_MISMATCH`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_TIMED_OUT`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`HEALTH_CHECK_STATUS_UNKNOWN`	A constant which can be used with the health_check_status property of a HealthCheckResult.
`health_check_status`	[Required] Gets the health_check_status of this HealthCheckResult.
`source_ip_address`	[Required] Gets the source_ip_address of this HealthCheckResult.
`subnet_id`	[Required] Gets the subnet_id of this HealthCheckResult.
`timestamp`	[Required] Gets the timestamp of this HealthCheckResult.

Methods

__init__(**kwargs) Initializes a new HealthCheckResult object with values from keyword arguments.

HEALTH_CHECK_STATUS_CONNECT_FAILED = 'CONNECT_FAILED'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “CONNECT_FAILED”

HEALTH_CHECK_STATUS_INVALID_STATUS_CODE = 'INVALID_STATUS_CODE'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “INVALID_STATUS_CODE”

HEALTH_CHECK_STATUS_IO_ERROR = 'IO_ERROR'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “IO_ERROR”

HEALTH_CHECK_STATUS_OFFLINE = 'OFFLINE'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “OFFLINE”

HEALTH_CHECK_STATUS_OK = 'OK'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “OK”

HEALTH_CHECK_STATUS_REGEX_MISMATCH = 'REGEX_MISMATCH'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “REGEX_MISMATCH”

HEALTH_CHECK_STATUS_TIMED_OUT = 'TIMED_OUT'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “TIMED_OUT”

HEALTH_CHECK_STATUS_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the health_check_status property of a HealthCheckResult. This constant has a value of “UNKNOWN”

__init__(**kwargs)¶

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

Parameters:

subnet_id (str) – The value to assign to the subnet_id property of this HealthCheckResult.
source_ip_address (str) – The value to assign to the source_ip_address property of this HealthCheckResult.
timestamp (datetime) – The value to assign to the timestamp property of this HealthCheckResult.
health_check_status (str) – The value to assign to the health_check_status property of this HealthCheckResult. Allowed values for this property are: “OK”, “INVALID_STATUS_CODE”, “TIMED_OUT”, “REGEX_MISMATCH”, “CONNECT_FAILED”, “IO_ERROR”, “OFFLINE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

health_check_status¶

[Required] Gets the health_check_status of this HealthCheckResult. The result of the most recent health check.

Allowed values for this property are: “OK”, “INVALID_STATUS_CODE”, “TIMED_OUT”, “REGEX_MISMATCH”, “CONNECT_FAILED”, “IO_ERROR”, “OFFLINE”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The health_check_status of this HealthCheckResult.
Return type:	str

source_ip_address¶

[Required] Gets the source_ip_address of this HealthCheckResult. The IP address of the health check status report provider. This identifier helps you differentiate same-subnet load balancers that report health check status.

Example: 10.0.0.7

Returns:	The source_ip_address of this HealthCheckResult.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this HealthCheckResult. The OCID of the subnet hosting the load balancer that reported this health check status.

Returns:	The subnet_id of this HealthCheckResult.
Return type:	str

timestamp¶

[Required] Gets the timestamp of this HealthCheckResult. The date and time the data was retrieved, in the format defined by RFC3339.

Example: 2017-06-02T18:28:11+00:00

Returns:	The timestamp of this HealthCheckResult.
Return type:	datetime