Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Probe.
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Generated from protobuf message google.cloud.aiplatform.v1.Probe
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ exec |
Google\Cloud\AIPlatform\V1\Probe\ExecAction
Exec specifies the action to take. |
↳ period_seconds |
int
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. |
↳ timeout_seconds |
int
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. |
getExec
Exec specifies the action to take.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\Probe\ExecAction|null | |
hasExec
setExec
Exec specifies the action to take.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\Probe\ExecAction
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPeriodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds.
Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
| Returns | |
|---|---|
| Type | Description |
int | |
setPeriodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds.
Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second.
Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
| Returns | |
|---|---|
| Type | Description |
int | |
setTimeoutSeconds
Number of seconds after which the probe times out. Defaults to 1 second.
Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProbeType
| Returns | |
|---|---|
| Type | Description |
string | |