Compute V1 Client - Class HealthCheck (1.13.0)

Version 1.13.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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

Represents a health check resource. Google Compute Engine has two health check resources: * Regional * Global These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require legacy HTTP health checks: * Target pool-based network load balancer Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ check_interval_sec	int How often (in seconds) to send a health check. The default value is 5 seconds.
↳ creation_timestamp	string [Output Only] Creation timestamp in 3339 text format.
↳ description	string An optional description of this resource. Provide this property when you create the resource.
↳ grpc_health_check	Google\Cloud\Compute\V1\GRPCHealthCheck
↳ healthy_threshold	int A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
↳ http2_health_check	Google\Cloud\Compute\V1\HTTP2HealthCheck
↳ http_health_check	Google\Cloud\Compute\V1\HTTPHealthCheck
↳ https_health_check	Google\Cloud\Compute\V1\HTTPSHealthCheck
↳ id	int|string [Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind	string Type of the resource.
↳ log_config	Google\Cloud\Compute\V1\HealthCheckLogConfig Configure logging on this health check.
↳ name	string Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
↳ region	string [Output Only] Region where the health check resides. Not applicable to global health checks.
↳ self_link	string [Output Only] Server-defined URL for the resource.
↳ ssl_health_check	Google\Cloud\Compute\V1\SSLHealthCheck
↳ tcp_health_check	Google\Cloud\Compute\V1\TCPHealthCheck
↳ timeout_sec	int How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
↳ type	string Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
↳ unhealthy_threshold	int A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

getCheckIntervalSec

How often (in seconds) to send a health check. The default value is 5 seconds.

Returns
Type	Description
int

hasCheckIntervalSec

clearCheckIntervalSec

setCheckIntervalSec

How often (in seconds) to send a health check. The default value is 5 seconds.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in 3339 text format.

Returns
Type	Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in 3339 text format.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type	Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGrpcHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;

Returns
Type	Description
Google\Cloud\Compute\V1\GRPCHealthCheck|null

hasGrpcHealthCheck

clearGrpcHealthCheck

setGrpcHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\GRPCHealthCheck

Returns
Type	Description
$this

getHealthyThreshold

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Returns
Type	Description
int

hasHealthyThreshold

clearHealthyThreshold

setHealthyThreshold

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getHttp2HealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;

Returns
Type	Description
Google\Cloud\Compute\V1\HTTP2HealthCheck|null

hasHttp2HealthCheck

clearHttp2HealthCheck

setHttp2HealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\HTTP2HealthCheck

Returns
Type	Description
$this

getHttpHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;

Returns
Type	Description
Google\Cloud\Compute\V1\HTTPHealthCheck|null

hasHttpHealthCheck

clearHttpHealthCheck

setHttpHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\HTTPHealthCheck

Returns
Type	Description
$this

getHttpsHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;

Returns
Type	Description
Google\Cloud\Compute\V1\HTTPSHealthCheck|null

hasHttpsHealthCheck

clearHttpsHealthCheck

setHttpsHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\HTTPSHealthCheck

Returns
Type	Description
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type	Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getKind

Type of the resource.

Returns
Type	Description
string

hasKind

clearKind

setKind

Type of the resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLogConfig

Configure logging on this health check.

Returns
Type	Description
Google\Cloud\Compute\V1\HealthCheckLogConfig|null

hasLogConfig

clearLogConfig

setLogConfig

Configure logging on this health check.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\HealthCheckLogConfig

Returns
Type	Description
$this

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.

Returns
Type	Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRegion

[Output Only] Region where the health check resides. Not applicable to global health checks.

Returns
Type	Description
string

hasRegion

clearRegion

setRegion

[Output Only] Region where the health check resides. Not applicable to global health checks.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type	Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSslHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;

Returns
Type	Description
Google\Cloud\Compute\V1\SSLHealthCheck|null

hasSslHealthCheck

clearSslHealthCheck

setSslHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\SSLHealthCheck

Returns
Type	Description
$this

getTcpHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;

Returns
Type	Description
Google\Cloud\Compute\V1\TCPHealthCheck|null

hasTcpHealthCheck

clearTcpHealthCheck

setTcpHealthCheck

Generated from protobuf field optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;

Parameter
Name	Description
var	Google\Cloud\Compute\V1\TCPHealthCheck

Returns
Type	Description
$this

getTimeoutSec

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

Returns
Type	Description
int

hasTimeoutSec

clearTimeoutSec

setTimeoutSec

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getType

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.

Check the Type enum for the list of possible values.

Returns
Type	Description
string

hasType

clearType

setType

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.

Check the Type enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUnhealthyThreshold

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Returns
Type	Description
int

hasUnhealthyThreshold

clearUnhealthyThreshold

setUnhealthyThreshold

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Parameter
Name	Description
var	int

Returns
Type	Description
$this