Google Cloud Appengine Admin V1 Client - Class LivenessCheck (1.0.6)

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

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.

Generated from protobuf message google.appengine.v1.LivenessCheck

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ path string

The request path.

↳ host string

Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"

↳ failure_threshold int

Number of consecutive failed checks required before considering the VM unhealthy.

↳ success_threshold int

Number of consecutive successful checks required before considering the VM healthy.

↳ check_interval Google\Protobuf\Duration

Interval between health checks.

↳ timeout Google\Protobuf\Duration

Time before the check is considered failed.

↳ initial_delay Google\Protobuf\Duration

The initial delay before starting to execute the checks.

getPath

The request path.

Returns
TypeDescription
string

setPath

The request path.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHost

Host header to send when performing a HTTP Liveness check.

Example: "myapp.appspot.com"

Returns
TypeDescription
string

setHost

Host header to send when performing a HTTP Liveness check.

Example: "myapp.appspot.com"

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFailureThreshold

Number of consecutive failed checks required before considering the VM unhealthy.

Returns
TypeDescription
int

setFailureThreshold

Number of consecutive failed checks required before considering the VM unhealthy.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSuccessThreshold

Number of consecutive successful checks required before considering the VM healthy.

Returns
TypeDescription
int

setSuccessThreshold

Number of consecutive successful checks required before considering the VM healthy.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCheckInterval

Interval between health checks.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasCheckInterval

clearCheckInterval

setCheckInterval

Interval between health checks.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getTimeout

Time before the check is considered failed.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

Time before the check is considered failed.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getInitialDelay

The initial delay before starting to execute the checks.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasInitialDelay

clearInitialDelay

setInitialDelay

The initial delay before starting to execute the checks.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this