LoadBalancerHealthSummary¶

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

Bases: object

A health status summary for the specified load balancer.

Attributes

`STATUS_CRITICAL`	A constant which can be used with the status property of a LoadBalancerHealthSummary.
`STATUS_OK`	A constant which can be used with the status property of a LoadBalancerHealthSummary.
`STATUS_UNKNOWN`	A constant which can be used with the status property of a LoadBalancerHealthSummary.
`STATUS_WARNING`	A constant which can be used with the status property of a LoadBalancerHealthSummary.
`load_balancer_id`	[Required] Gets the load_balancer_id of this LoadBalancerHealthSummary.
`status`	[Required] Gets the status of this LoadBalancerHealthSummary.

Methods

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

STATUS_CRITICAL = 'CRITICAL'¶: A constant which can be used with the status property of a LoadBalancerHealthSummary. This constant has a value of “CRITICAL”

STATUS_OK = 'OK'¶: A constant which can be used with the status property of a LoadBalancerHealthSummary. This constant has a value of “OK”

STATUS_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the status property of a LoadBalancerHealthSummary. This constant has a value of “UNKNOWN”

STATUS_WARNING = 'WARNING'¶: A constant which can be used with the status property of a LoadBalancerHealthSummary. This constant has a value of “WARNING”

__init__(**kwargs)¶

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

Parameters:

load_balancer_id (str) – The value to assign to the load_balancer_id property of this LoadBalancerHealthSummary.
status (str) – The value to assign to the status property of this LoadBalancerHealthSummary. Allowed values for this property are: “OK”, “WARNING”, “CRITICAL”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

load_balancer_id¶

[Required] Gets the load_balancer_id of this LoadBalancerHealthSummary. The OCID of the load balancer the health status is associated with.

Returns:	The load_balancer_id of this LoadBalancerHealthSummary.
Return type:	str

status¶

[Required] Gets the status of this LoadBalancerHealthSummary. The overall health status of the load balancer.

OK: All backend sets associated with the load balancer return a status of OK.
WARNING: At least one of the backend sets associated with the load balancer returns a status of WARNING,

no backend sets return a status of CRITICAL, and the load balancer life cycle state is ACTIVE.

CRITICAL: One or more of the backend sets associated with the load balancer return a status of CRITICAL.
UNKNOWN: If any one of the following conditions is true:
- The load balancer life cycle state is not ACTIVE.
- No backend sets are defined for the load balancer.
- More than half of the backend sets associated with the load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the load balancer life cycle state is ACTIVE.
- The system could not retrieve metrics for any reason.

Allowed values for this property are: “OK”, “WARNING”, “CRITICAL”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this LoadBalancerHealthSummary.
Return type:	str