Google Cloud Appengine Admin V1 Client - Class HealthCheck (2.0.3)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class HealthCheck.

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.

Generated from protobuf message google.appengine.v1.HealthCheck

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ disable_health_check
bool

Whether to explicitly disable health checks for this instance.

↳ host
string

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

↳ healthy_threshold
int

Number of consecutive successful health checks required before receiving traffic.

↳ unhealthy_threshold
int

Number of consecutive failed health checks required before removing traffic.

↳ restart_threshold
int

Number of consecutive failed health checks required before an instance is restarted.

↳ check_interval
Google\Protobuf\Duration

Interval between health checks.

↳ timeout
Google\Protobuf\Duration

Time before the health check is considered failed.

getDisableHealthCheck

Whether to explicitly disable health checks for this instance.

Returns
Type
Description
bool

setDisableHealthCheck

Whether to explicitly disable health checks for this instance.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getHost

Host header to send when performing an HTTP health check.

Example: "myapp.appspot.com"

Returns
Type
Description
string

setHost

Host header to send when performing an HTTP health check.

Example: "myapp.appspot.com"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getHealthyThreshold

Number of consecutive successful health checks required before receiving traffic.

Returns
Type
Description
int

setHealthyThreshold

Number of consecutive successful health checks required before receiving traffic.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getUnhealthyThreshold

Number of consecutive failed health checks required before removing traffic.

Returns
Type
Description
int

setUnhealthyThreshold

Number of consecutive failed health checks required before removing traffic.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getRestartThreshold

Number of consecutive failed health checks required before an instance is restarted.

Returns
Type
Description
int

setRestartThreshold

Number of consecutive failed health checks required before an instance is restarted.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCheckInterval

Interval between health checks.

Returns
Type
Description

hasCheckInterval

clearCheckInterval

setCheckInterval

Interval between health checks.

Parameter
Name
Description
Returns
Type
Description
$this

getTimeout

Time before the health check is considered failed.

Returns
Type
Description

hasTimeout

clearTimeout

setTimeout

Time before the health check is considered failed.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: