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 | |
|---|---|
| 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 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 | |
|---|---|
| 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 Liveness check.
Example: "myapp.appspot.com"
| Returns | |
|---|---|
| Type | Description |
string | |
setHost
Host header to send when performing a HTTP Liveness check.
Example: "myapp.appspot.com"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFailureThreshold
Number of consecutive failed checks required before considering the VM unhealthy.
| Returns | |
|---|---|
| Type | Description |
int | |
setFailureThreshold
Number of consecutive failed checks required before considering the VM unhealthy.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSuccessThreshold
Number of consecutive successful checks required before considering the VM healthy.
| Returns | |
|---|---|
| Type | Description |
int | |
setSuccessThreshold
Number of consecutive successful checks required before considering the VM healthy.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCheckInterval
Interval between health checks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasCheckInterval
clearCheckInterval
setCheckInterval
Interval between health checks.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimeout
Time before the check is considered failed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasTimeout
clearTimeout
setTimeout
Time before the check is considered failed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInitialDelay
The initial delay before starting to execute the checks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasInitialDelay
clearInitialDelay
setInitialDelay
The initial delay before starting to execute the checks.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |