Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Probe.
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#exec
def exec() -> ::Google::Cloud::AIPlatform::V1::Probe::ExecAction-
(::Google::Cloud::AIPlatform::V1::Probe::ExecAction) — ExecAction probes the health of a container by executing a command.
Note: The following fields are mutually exclusive:
exec,http_get,grpc,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
#exec=
def exec=(value) -> ::Google::Cloud::AIPlatform::V1::Probe::ExecAction-
value (::Google::Cloud::AIPlatform::V1::Probe::ExecAction) — ExecAction probes the health of a container by executing a command.
Note: The following fields are mutually exclusive:
exec,http_get,grpc,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::AIPlatform::V1::Probe::ExecAction) — ExecAction probes the health of a container by executing a command.
Note: The following fields are mutually exclusive:
exec,http_get,grpc,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
#failure_threshold
def failure_threshold() -> ::Integer-
(::Integer) — Number of consecutive failures before the probe is considered failed.
Defaults to 3. Minimum value is 1.
Maps to Kubernetes probe argument 'failureThreshold'.
#failure_threshold=
def failure_threshold=(value) -> ::Integer-
value (::Integer) — Number of consecutive failures before the probe is considered failed.
Defaults to 3. Minimum value is 1.
Maps to Kubernetes probe argument 'failureThreshold'.
-
(::Integer) — Number of consecutive failures before the probe is considered failed.
Defaults to 3. Minimum value is 1.
Maps to Kubernetes probe argument 'failureThreshold'.
#grpc
def grpc() -> ::Google::Cloud::AIPlatform::V1::Probe::GrpcAction-
(::Google::Cloud::AIPlatform::V1::Probe::GrpcAction) — GrpcAction probes the health of a container by sending a gRPC request.
Note: The following fields are mutually exclusive:
grpc,exec,http_get,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
#grpc=
def grpc=(value) -> ::Google::Cloud::AIPlatform::V1::Probe::GrpcAction-
value (::Google::Cloud::AIPlatform::V1::Probe::GrpcAction) — GrpcAction probes the health of a container by sending a gRPC request.
Note: The following fields are mutually exclusive:
grpc,exec,http_get,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::AIPlatform::V1::Probe::GrpcAction) — GrpcAction probes the health of a container by sending a gRPC request.
Note: The following fields are mutually exclusive:
grpc,exec,http_get,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
#http_get
def http_get() -> ::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction-
(::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction) — HttpGetAction probes the health of a container by sending an HTTP GET
request.
Note: The following fields are mutually exclusive:
http_get,exec,grpc,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
#http_get=
def http_get=(value) -> ::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction-
value (::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction) — HttpGetAction probes the health of a container by sending an HTTP GET
request.
Note: The following fields are mutually exclusive:
http_get,exec,grpc,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction) — HttpGetAction probes the health of a container by sending an HTTP GET
request.
Note: The following fields are mutually exclusive:
http_get,exec,grpc,tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.
#initial_delay_seconds
def initial_delay_seconds() -> ::Integer-
(::Integer) — Number of seconds to wait before starting the probe. Defaults to 0.
Minimum value is 0.
Maps to Kubernetes probe argument 'initialDelaySeconds'.
#initial_delay_seconds=
def initial_delay_seconds=(value) -> ::Integer-
value (::Integer) — Number of seconds to wait before starting the probe. Defaults to 0.
Minimum value is 0.
Maps to Kubernetes probe argument 'initialDelaySeconds'.
-
(::Integer) — Number of seconds to wait before starting the probe. Defaults to 0.
Minimum value is 0.
Maps to Kubernetes probe argument 'initialDelaySeconds'.
#period_seconds
def period_seconds() -> ::Integer-
(::Integer) — 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'.
#period_seconds=
def period_seconds=(value) -> ::Integer-
value (::Integer) — 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'.
-
(::Integer) — 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'.
#success_threshold
def success_threshold() -> ::Integer-
(::Integer) — Number of consecutive successes before the probe is considered successful.
Defaults to 1. Minimum value is 1.
Maps to Kubernetes probe argument 'successThreshold'.
#success_threshold=
def success_threshold=(value) -> ::Integer-
value (::Integer) — Number of consecutive successes before the probe is considered successful.
Defaults to 1. Minimum value is 1.
Maps to Kubernetes probe argument 'successThreshold'.
-
(::Integer) — Number of consecutive successes before the probe is considered successful.
Defaults to 1. Minimum value is 1.
Maps to Kubernetes probe argument 'successThreshold'.
#tcp_socket
def tcp_socket() -> ::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction-
(::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction) — TcpSocketAction probes the health of a container by opening a TCP socket
connection.
Note: The following fields are mutually exclusive:
tcp_socket,exec,http_get,grpc. If a field in that set is populated, all other fields in the set will automatically be cleared.
#tcp_socket=
def tcp_socket=(value) -> ::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction-
value (::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction) — TcpSocketAction probes the health of a container by opening a TCP socket
connection.
Note: The following fields are mutually exclusive:
tcp_socket,exec,http_get,grpc. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction) — TcpSocketAction probes the health of a container by opening a TCP socket
connection.
Note: The following fields are mutually exclusive:
tcp_socket,exec,http_get,grpc. If a field in that set is populated, all other fields in the set will automatically be cleared.
#timeout_seconds
def timeout_seconds() -> ::Integer-
(::Integer) — 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'.
#timeout_seconds=
def timeout_seconds=(value) -> ::Integer-
value (::Integer) — 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'.
-
(::Integer) — 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'.