Google Cloud Ai Platform V1 Client - Class Probe (1.17.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ exec`	`Probe\ExecAction` ExecAction probes the health of a container by executing a command.
`↳ http_get`	`Probe\HttpGetAction` HttpGetAction probes the health of a container by sending an HTTP GET request.
`↳ grpc`	`Probe\GrpcAction` GrpcAction probes the health of a container by sending a gRPC request.
`↳ tcp_socket`	`Probe\TcpSocketAction` TcpSocketAction probes the health of a container by opening a TCP socket connection.
`↳ 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'.
`↳ failure_threshold`	`int` Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.
`↳ success_threshold`	`int` Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.
`↳ initial_delay_seconds`	`int` Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.

getExec

ExecAction probes the health of a container by executing a command.

Returns
Type	Description
`Probe\ExecAction\|null`

hasExec

setExec

ExecAction probes the health of a container by executing a command.

Parameter
Name	Description
`var`	`Probe\ExecAction`

Returns
Type	Description
`$this`

getHttpGet

HttpGetAction probes the health of a container by sending an HTTP GET request.

Returns
Type	Description
`Probe\HttpGetAction\|null`

hasHttpGet

setHttpGet

HttpGetAction probes the health of a container by sending an HTTP GET request.

Parameter
Name	Description
`var`	`Probe\HttpGetAction`

Returns
Type	Description
`$this`

getGrpc

GrpcAction probes the health of a container by sending a gRPC request.

Returns
Type	Description
`Probe\GrpcAction\|null`

hasGrpc

setGrpc

GrpcAction probes the health of a container by sending a gRPC request.

Parameter
Name	Description
`var`	`Probe\GrpcAction`

Returns
Type	Description
`$this`

getTcpSocket

TcpSocketAction probes the health of a container by opening a TCP socket connection.

Returns
Type	Description
`Probe\TcpSocketAction\|null`

hasTcpSocket

setTcpSocket

TcpSocketAction probes the health of a container by opening a TCP socket connection.

Parameter
Name	Description
`var`	`Probe\TcpSocketAction`

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`

getFailureThreshold

Number of consecutive failures before the probe is considered failed.

Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.

Returns
Type	Description
`int`

setFailureThreshold

Number of consecutive failures before the probe is considered failed.

Defaults to 3. Minimum value is 1. Maps to Kubernetes probe argument 'failureThreshold'.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSuccessThreshold

Number of consecutive successes before the probe is considered successful.

Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.

Returns
Type	Description
`int`

setSuccessThreshold

Number of consecutive successes before the probe is considered successful.

Defaults to 1. Minimum value is 1. Maps to Kubernetes probe argument 'successThreshold'.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getInitialDelaySeconds

Number of seconds to wait before starting the probe. Defaults to 0.

Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.

Returns
Type	Description
`int`

setInitialDelaySeconds

Number of seconds to wait before starting the probe. Defaults to 0.

Minimum value is 0. Maps to Kubernetes probe argument 'initialDelaySeconds'.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getProbeType

Returns
Type	Description
`string`