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

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

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

Generated from protobuf message google.appengine.v1.ReadinessCheck

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ path
string

The request path.

↳ host
string

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

↳ failure_threshold
int

Number of consecutive failed checks required before removing traffic.

↳ success_threshold
int

Number of consecutive successful checks required before receiving traffic.

↳ check_interval
Google\Protobuf\Duration

Interval between health checks.

↳ timeout
Google\Protobuf\Duration

Time before the check is considered failed.

↳ app_start_timeout
Google\Protobuf\Duration

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

getPath

The request path.

Returns
Type
Description
string

setPath

The request path.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getHost

Host header to send when performing a HTTP Readiness check.

Example: "myapp.appspot.com"

Returns
Type
Description
string

setHost

Host header to send when performing a HTTP Readiness check.

Example: "myapp.appspot.com"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFailureThreshold

Number of consecutive failed checks required before removing traffic.

Returns
Type
Description
int

setFailureThreshold

Number of consecutive failed checks required before removing traffic.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getSuccessThreshold

Number of consecutive successful checks required before receiving traffic.

Returns
Type
Description
int

setSuccessThreshold

Number of consecutive successful checks required before receiving traffic.

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 check is considered failed.

Returns
Type
Description

hasTimeout

clearTimeout

setTimeout

Time before the check is considered failed.

Parameter
Name
Description
Returns
Type
Description
$this

getAppStartTimeout

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

Returns
Type
Description

hasAppStartTimeout

clearAppStartTimeout

setAppStartTimeout

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

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