Metadata defined as annotations for network endpoint.
↳ forwarding_rule
string
URL of the forwarding rule associated with the health status of the instance.
↳ forwarding_rule_ip
string
A forwarding rule IP address assigned to this instance.
↳ health_state
string
Health state of the IPv4 address of the instance. Check the HealthState enum for the list of possible values.
↳ instance
string
URL of the instance resource.
↳ ip_address
string
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.
↳ ipv6_address
string
↳ ipv6_health_state
string
Health state of the IPv6 address of the instance. Check the Ipv6HealthState enum for the list of possible values.
↳ port
int
The named port of the instance group, not necessarily the port that is health-checked.
↳ weight
string
↳ weight_error
string
Check the WeightError enum for the list of possible values.
getAnnotations
Metadata defined as annotations for network endpoint.
URL of the forwarding rule associated with the health status of the instance.
Returns
Type
Description
string
hasForwardingRule
clearForwardingRule
setForwardingRule
URL of the forwarding rule associated with the health status of the instance.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getForwardingRuleIp
A forwarding rule IP address assigned to this instance.
Returns
Type
Description
string
hasForwardingRuleIp
clearForwardingRuleIp
setForwardingRuleIp
A forwarding rule IP address assigned to this instance.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getHealthState
Health state of the IPv4 address of the instance.
Check the HealthState enum for the list of possible values.
Returns
Type
Description
string
hasHealthState
clearHealthState
setHealthState
Health state of the IPv4 address of the instance.
Check the HealthState enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getInstance
URL of the instance resource.
Returns
Type
Description
string
hasInstance
clearInstance
setInstance
URL of the instance resource.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIpAddress
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.
Returns
Type
Description
string
hasIpAddress
clearIpAddress
setIpAddress
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIpv6Address
Generated from protobuf fieldoptional string ipv6_address = 341563804;
Returns
Type
Description
string
hasIpv6Address
clearIpv6Address
setIpv6Address
Generated from protobuf fieldoptional string ipv6_address = 341563804;
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIpv6HealthState
Health state of the IPv6 address of the instance.
Check the Ipv6HealthState enum for the list of possible values.
Returns
Type
Description
string
hasIpv6HealthState
clearIpv6HealthState
setIpv6HealthState
Health state of the IPv6 address of the instance.
Check the Ipv6HealthState enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPort
The named port of the instance group, not necessarily the port that is health-checked.
Returns
Type
Description
int
hasPort
clearPort
setPort
The named port of the instance group, not necessarily the port that is health-checked.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getWeight
Generated from protobuf fieldoptional string weight = 282149496;
Returns
Type
Description
string
hasWeight
clearWeight
setWeight
Generated from protobuf fieldoptional string weight = 282149496;
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getWeightError
Check the WeightError enum for the list of possible values.
Returns
Type
Description
string
hasWeightError
clearWeightError
setWeightError
Check the WeightError enum for the list of possible values.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class HealthStatus (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.HealthStatus)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.HealthStatus)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.HealthStatus)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.HealthStatus)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.HealthStatus)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.HealthStatus)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.HealthStatus)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.HealthStatus)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.HealthStatus)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.HealthStatus)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.HealthStatus)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.HealthStatus)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.HealthStatus)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.HealthStatus)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.HealthStatus)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.HealthStatus)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.HealthStatus)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.HealthStatus)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.HealthStatus)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.HealthStatus)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.HealthStatus)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.HealthStatus)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.HealthStatus)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.HealthStatus)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.HealthStatus)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.HealthStatus)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.HealthStatus)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.HealthStatus)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.HealthStatus)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.HealthStatus) \nReference documentation and code samples for the Compute V1 Client class HealthStatus.\n\nGenerated from protobuf message `google.cloud.compute.v1.HealthStatus`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAnnotations\n\nMetadata defined as annotations for network endpoint.\n\n### setAnnotations\n\nMetadata defined as annotations for network endpoint.\n\n### getForwardingRule\n\nURL of the forwarding rule associated with the health status of the instance.\n\n### hasForwardingRule\n\n### clearForwardingRule\n\n### setForwardingRule\n\nURL of the forwarding rule associated with the health status of the instance.\n\n### getForwardingRuleIp\n\nA forwarding rule IP address assigned to this instance.\n\n### hasForwardingRuleIp\n\n### clearForwardingRuleIp\n\n### setForwardingRuleIp\n\nA forwarding rule IP address assigned to this instance.\n\n### getHealthState\n\nHealth state of the IPv4 address of the instance.\n\nCheck the HealthState enum for the list of possible values.\n\n### hasHealthState\n\n### clearHealthState\n\n### setHealthState\n\nHealth state of the IPv4 address of the instance.\n\nCheck the HealthState enum for the list of possible values.\n\n### getInstance\n\nURL of the instance resource.\n\n### hasInstance\n\n### clearInstance\n\n### setInstance\n\nURL of the instance resource.\n\n### getIpAddress\n\nFor 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.\n\n### hasIpAddress\n\n### clearIpAddress\n\n### setIpAddress\n\nFor 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.\n\n### getIpv6Address\n\nGenerated from protobuf field `optional string ipv6_address = 341563804;`\n\n### hasIpv6Address\n\n### clearIpv6Address\n\n### setIpv6Address\n\nGenerated from protobuf field `optional string ipv6_address = 341563804;`\n\n### getIpv6HealthState\n\nHealth state of the IPv6 address of the instance.\n\nCheck the Ipv6HealthState enum for the list of possible values.\n\n### hasIpv6HealthState\n\n### clearIpv6HealthState\n\n### setIpv6HealthState\n\nHealth state of the IPv6 address of the instance.\n\nCheck the Ipv6HealthState enum for the list of possible values.\n\n### getPort\n\nThe named port of the instance group, not necessarily the port that is health-checked.\n\n### hasPort\n\n### clearPort\n\n### setPort\n\nThe named port of the instance group, not necessarily the port that is health-checked.\n\n### getWeight\n\nGenerated from protobuf field `optional string weight = 282149496;`\n\n### hasWeight\n\n### clearWeight\n\n### setWeight\n\nGenerated from protobuf field `optional string weight = 282149496;`\n\n### getWeightError\n\nCheck the WeightError enum for the list of possible values.\n\n### hasWeightError\n\n### clearWeightError\n\n### setWeightError\n\nCheck the WeightError enum for the list of possible values."]]
