Package org.cdk8s.plus24.k8s

Interface Probe

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Probe.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-13T15:58:20.189Z")
@Stability(Stable)
public interface Probe
extends software.amazon.jsii.JsiiSerializable

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Probe.Builder	A builder for Probe
static class	Probe.Jsii$Proxy	An implementation for Probe

Method Summary

Modifier and Type	Method	Description
static Probe.Builder	builder()
default ExecAction	getExec()	Exec specifies the action to take.
default Number	getFailureThreshold()	Minimum consecutive failures for the probe to be considered failed after having succeeded.
default GrpcAction	getGrpc()	GRPC specifies an action involving a GRPC port.
default HttpGetAction	getHttpGet()	HTTPGet specifies the http request to perform.
default Number	getInitialDelaySeconds()	Number of seconds after the container has started before liveness probes are initiated.
default Number	getPeriodSeconds()	How often (in seconds) to perform the probe.
default Number	getSuccessThreshold()	Minimum consecutive successes for the probe to be considered successful after having failed.
default TcpSocketAction	getTcpSocket()	TCPSocket specifies an action involving a TCP port.
default Number	getTerminationGracePeriodSeconds()	Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
default Number	getTimeoutSeconds()	Number of seconds after which the probe times out.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getExec

@Stability(Stable)
@Nullable
default ExecAction getExec()

Exec specifies the action to take.

getFailureThreshold

@Stability(Stable)
@Nullable
default Number getFailureThreshold()

Minimum consecutive failures for the probe to be considered failed after having succeeded.

Defaults to 3. Minimum value is 1.

Default: 3. Minimum value is 1.

getGrpc

@Stability(Stable)
@Nullable
default GrpcAction getGrpc()

GRPC specifies an action involving a GRPC port.

This is a beta field and requires enabling GRPCContainerProbe feature gate.

getHttpGet

@Stability(Stable)
@Nullable
default HttpGetAction getHttpGet()

HTTPGet specifies the http request to perform.

getInitialDelaySeconds

@Stability(Stable)
@Nullable
default Number getInitialDelaySeconds()

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

getPeriodSeconds

@Stability(Stable)
@Nullable
default Number getPeriodSeconds()

How often (in seconds) to perform the probe.

Default to 10 seconds. Minimum value is 1.

Default: 10 seconds. Minimum value is 1.

getSuccessThreshold

@Stability(Stable)
@Nullable
default Number getSuccessThreshold()

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.

Default: 1. Must be 1 for liveness and startup. Minimum value is 1.

getTcpSocket

@Stability(Stable)
@Nullable
default TcpSocketAction getTcpSocket()

TCPSocket specifies an action involving a TCP port.

getTerminationGracePeriodSeconds

@Stability(Stable)
@Nullable
default Number getTerminationGracePeriodSeconds()

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.

getTimeoutSeconds

@Stability(Stable)
@Nullable
default Number getTimeoutSeconds()

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

Default: 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

builder

@Stability(Stable)
static Probe.Builder builder()

Returns:

a Probe.Builder of Probe