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> ? terminationGracePeriodSeconds, Input<int> ? timeoutSeconds}) -
Creates a new Probe.
execExec specifies a command to execute in the container.failureThresholdMinimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.grpcGRPC specifies a GRPC HealthCheckRequest.httpGetHTTPGet specifies an HTTP GET request to perform.initialDelaySecondsNumber of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probesperiodSecondsHow often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.successThresholdMinimum 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.tcpSocketTCPSocket specifies a connection to a TCP port.terminationGracePeriodSecondsOptional 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.timeoutSecondsNumber 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-probesconst -
Probe.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
exec
→ Input<
ExecAction> ? -
Exec specifies a command to execute in the container.
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> ? -
GRPC specifies a GRPC HealthCheckRequest.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
httpGet
→ Input<
HTTPGetAction> ? -
HTTPGet specifies an HTTP GET request to perform.
final
-
initialDelaySeconds
→ Input<
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
→ Input<
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 setterinherited
-
successThreshold
→ Input<
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
→ Input<
TCPSocketAction> ? -
TCPSocket specifies a connection to a TCP port.
final
-
terminationGracePeriodSeconds
→ Input<
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
→ Input<
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
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited