Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::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
#failure_threshold
def failure_threshold() -> ::Integer
Returns
- (::Integer) — Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
#failure_threshold=
def failure_threshold=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
Returns
- (::Integer) — Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
#grpc
def grpc() -> ::Google::Cloud::Run::V2::GRPCAction
Returns
- (::Google::Cloud::Run::V2::GRPCAction) — Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
#grpc=
def grpc=(value) -> ::Google::Cloud::Run::V2::GRPCAction
Parameter
- value (::Google::Cloud::Run::V2::GRPCAction) — Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
Returns
- (::Google::Cloud::Run::V2::GRPCAction) — Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
#http_get
def http_get() -> ::Google::Cloud::Run::V2::HTTPGetAction
Returns
- (::Google::Cloud::Run::V2::HTTPGetAction) — Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
#http_get=
def http_get=(value) -> ::Google::Cloud::Run::V2::HTTPGetAction
Parameter
- value (::Google::Cloud::Run::V2::HTTPGetAction) — Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
Returns
- (::Google::Cloud::Run::V2::HTTPGetAction) — Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
#initial_delay_seconds
def initial_delay_seconds() -> ::Integer
Returns
- (::Integer) — Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
#initial_delay_seconds=
def initial_delay_seconds=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
Returns
- (::Integer) — Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
#period_seconds
def period_seconds() -> ::Integer
Returns
- (::Integer) — Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
#period_seconds=
def period_seconds=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
Returns
- (::Integer) — Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
#tcp_socket
def tcp_socket() -> ::Google::Cloud::Run::V2::TCPSocketAction
Returns
- (::Google::Cloud::Run::V2::TCPSocketAction) — Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
#tcp_socket=
def tcp_socket=(value) -> ::Google::Cloud::Run::V2::TCPSocketAction
Parameter
- value (::Google::Cloud::Run::V2::TCPSocketAction) — Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
Returns
- (::Google::Cloud::Run::V2::TCPSocketAction) — Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
#timeout_seconds
def timeout_seconds() -> ::Integer
Returns
- (::Integer) — Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
#timeout_seconds=
def timeout_seconds=(value) -> ::Integer
Parameter
- value (::Integer) — Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
Returns
- (::Integer) — Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.