org.cdk8s.plus

Interface ProbeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CommandProbeOptions, HttpGetProbeOptions

All Known Implementing Classes:

CommandProbeOptions.Jsii$Proxy, HttpGetProbeOptions.Jsii$Proxy, ProbeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-21T06:58:44.687Z")
 @Stability(value=Experimental)
public interface ProbeOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Probe options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ProbeOptions.Builder	builder()
default Number	getFailureThreshold() (experimental) Minimum consecutive failures for the probe to be considered failed after having succeeded.
default Duration	getInitialDelaySeconds() (experimental) Number of seconds after the container has started before liveness probes are initiated.
default Duration	getPeriodSeconds() (experimental) How often (in seconds) to perform the probe.
default Number	getSuccessThreshold() (experimental) Minimum consecutive successes for the probe to be considered successful after having failed.
default Duration	getTimeoutSeconds() (experimental) Number of seconds after which the probe times out.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailureThreshold

@Stability(value=Experimental)
 @Nullable
default Number getFailureThreshold()

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

Defaults to 3. Minimum value is 1.

Default: 3

getInitialDelaySeconds

@Stability(value=Experimental)
 @Nullable
default Duration getInitialDelaySeconds()

(experimental) Number of seconds after the container has started before liveness probes are initiated.

Default: - immediate

See Also:

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

getPeriodSeconds

@Stability(value=Experimental)
 @Nullable
default Duration getPeriodSeconds()

(experimental) How often (in seconds) to perform the probe.

Default to 10 seconds. Minimum value is 1.

Default: Duration.seconds(10) Minimum value is 1.

getSuccessThreshold

@Stability(value=Experimental)
 @Nullable
default Number getSuccessThreshold()

(experimental) 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.

getTimeoutSeconds

@Stability(value=Experimental)
 @Nullable
default Duration getTimeoutSeconds()

(experimental) Number of seconds after which the probe times out.

Defaults to 1 second. Minimum value is 1.

Default: Duration.seconds(1)

See Also:

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

builder

@Stability(value=Experimental)
static ProbeOptions.Builder builder()

Returns:

a ProbeOptions.Builder of ProbeOptions