Class HealthStatus (1.18.0)

Version 1.18.0

• 1.23.0 (latest)
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

HealthStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
annotations	MutableMapping[str, str] Metadata defined as annotations for network endpoint.
forwarding_rule	str URL of the forwarding rule associated with the health status of the instance. This field is a member of oneof_ _forwarding_rule.
forwarding_rule_ip	str A forwarding rule IP address assigned to this instance. This field is a member of oneof_ _forwarding_rule_ip.
health_state	str Health state of the IPv4 address of the instance. Check the HealthState enum for the list of possible values. This field is a member of oneof_ _health_state.
instance	str URL of the instance resource. This field is a member of oneof_ _instance.
ip_address	str For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip. This field is a member of oneof_ _ip_address.
port	int The named port of the instance group, not necessarily the port that is health-checked. This field is a member of oneof_ _port.
weight	str This field is a member of oneof_ _weight.
weight_error	str Check the WeightError enum for the list of possible values. This field is a member of oneof_ _weight_error.

Classes

AnnotationsEntry

AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

HealthState

HealthState(value)

Health state of the IPv4 address of the instance.

Values: UNDEFINED_HEALTH_STATE (0): A value indicating that the enum field is not set. HEALTHY (439801213): No description available. UNHEALTHY (462118084): No description available.

WeightError

WeightError(value)

Values: UNDEFINED_WEIGHT_ERROR (0): A value indicating that the enum field is not set. INVALID_WEIGHT (383698400): The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation). MISSING_WEIGHT (384027537): The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight. UNAVAILABLE_WEIGHT (439464295): This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN. WEIGHT_NONE (502428831): This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight.