Probe class

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Constructors

Probe({Input<ExecAction>? exec, Input<int>? failureThreshold, Input<GRPCAction>? grpc, Input<HTTPGetAction>? httpGet, Input<int>? initialDelaySeconds, Input<int>? periodSeconds, Input<int>? successThreshold, Input<TCPSocketAction>? tcpSocket, Input<int>? timeoutSeconds})

Creates a new Probe. exec Not supported by Cloud Run. failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. grpc GRPCAction specifies an action involving a GRPC port. httpGet HTTPGet specifies the http request to perform. initialDelaySeconds 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. periodSeconds 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. successThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set. tcpSocket TCPSocket specifies an action involving a TCP port. timeoutSeconds 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; if period_seconds is not set, must be less or equal than 10.

const

Probe.fromMap(Map<String, dynamic> map)

factory

Properties

exec → Input<ExecAction>?

Not supported by Cloud Run.

final

failureThreshold → Input<int>?

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

final

grpc → Input<GRPCAction>?

GRPCAction specifies an action involving a GRPC port.

final

hashCode → int

The hash code for this object.

no setter, inherited

httpGet → Input<HTTPGetAction>?

HTTPGet specifies the http request to perform.

final

initialDelaySeconds → Input<int>?

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.

final

periodSeconds → Input<int>?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

successThreshold → Input<int>?

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.

final

tcpSocket → Input<TCPSocketAction>?

TCPSocket specifies an action involving a TCP port.

final

timeoutSeconds → Input<int>?

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; if period_seconds is not set, must be less or equal than 10.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited