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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
Metadata defined as annotations for network endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getForwardingRule
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 instance.
Check the HealthState enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasHealthState
clearHealthState
setHealthState
Health state 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 | |
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 field optional string weight = 282149496;
| Returns | |
|---|---|
| Type | Description |
string | |
hasWeight
clearWeight
setWeight
Generated from protobuf field optional 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |