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({ExecAction? exec, int? failureThreshold, GRPCAction? grpc, HTTPGetAction? httpGet, int? initialDelaySeconds, int? periodSeconds, int? successThreshold, TCPSocketAction? tcpSocket, int? terminationGracePeriodSeconds, int? timeoutSeconds})

Default constructor.

const

Probe.fromJson(Map<String, dynamic> json)

Creates a Probe from JSON data.

factory

Properties

exec → ExecAction?

Exec specifies the action to take.

final

failureThreshold → int?

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

final

grpc → GRPCAction?

GRPC specifies an action involving a GRPC port.

final

hashCode → int

The hash code for this object.

no setter, inherited

httpGet → HTTPGetAction?

HTTPGet specifies the http request to perform.

final

initialDelaySeconds → int?

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

final

periodSeconds → int?

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

successThreshold → int?

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

final

tcpSocket → TCPSocketAction?

TCPSocket specifies an action involving a TCP port.

final

terminationGracePeriodSeconds → int?

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

final

timeoutSeconds → int?

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object>

Converts a Probe instance to JSON data.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited