Compute V1 Client - Class HealthStatus (1.8.3)

Reference documentation and code samples for the Compute V1 Client class HealthStatus.

Generated from protobuf message google.cloud.compute.v1.HealthStatus

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ annotations array|Google\Protobuf\Internal\MapField

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 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.

↳ 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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setAnnotations

Metadata defined as annotations for network endpoint.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getForwardingRule

URL of the forwarding rule associated with the health status of the instance.

Returns
TypeDescription
string

hasForwardingRule

clearForwardingRule

setForwardingRule

URL of the forwarding rule associated with the health status of the instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForwardingRuleIp

A forwarding rule IP address assigned to this instance.

Returns
TypeDescription
string

hasForwardingRuleIp

clearForwardingRuleIp

setForwardingRuleIp

A forwarding rule IP address assigned to this instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHealthState

Health state of the instance.

Check the HealthState enum for the list of possible values.

Returns
TypeDescription
string

hasHealthState

clearHealthState

setHealthState

Health state of the instance.

Check the HealthState enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstance

URL of the instance resource.

Returns
TypeDescription
string

hasInstance

clearInstance

setInstance

URL of the instance resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getPort

The named port of the instance group, not necessarily the port that is health-checked.

Returns
TypeDescription
int

hasPort

clearPort

setPort

The named port of the instance group, not necessarily the port that is health-checked.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getWeight

Generated from protobuf field optional string weight = 282149496;

Returns
TypeDescription
string

hasWeight

clearWeight

setWeight

Generated from protobuf field optional string weight = 282149496;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWeightError

Check the WeightError enum for the list of possible values.

Returns
TypeDescription
string

hasWeightError

clearWeightError

setWeightError

Check the WeightError enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this