ProbeOptions (org.cdk8s:cdk8s-plus-20 1.0.0-beta.144 API)

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CommandProbeOptions, HttpGetProbeOptions, TcpSocketProbeOptions

All Known Implementing Classes:

CommandProbeOptions.Jsii$Proxy, HttpGetProbeOptions.Jsii$Proxy, ProbeOptions.Jsii$Proxy, TcpSocketProbeOptions.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.56.0 (build 55e7d15)",
           date="2022-04-13T14:52:28.928Z")
@Stability(Stable)
public interface ProbeOptions
extends software.amazon.jsii.JsiiSerializable
```
Probe options.

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static ProbeOptions.Builder`	`builder()`
`default Number`	`getFailureThreshold()`	Minimum consecutive failures for the probe to be considered failed after having succeeded.
`default org.cdk8s.Duration`	`getInitialDelaySeconds()`	Number of seconds after the container has started before liveness probes are initiated.
`default org.cdk8s.Duration`	`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 org.cdk8s.Duration`	`getTimeoutSeconds()`	Number of seconds after which the probe times out.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - 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
  - getInitialDelaySeconds
```
@Stability(Stable)
@Nullable
default org.cdk8s.Duration getInitialDelaySeconds()
```
    Number of seconds after the container has started before liveness probes are initiated.
    Default: - immediate
  - getPeriodSeconds
```
@Stability(Stable)
@Nullable
default org.cdk8s.Duration getPeriodSeconds()
```
    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(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.
  - getTimeoutSeconds
```
@Stability(Stable)
@Nullable
default org.cdk8s.Duration getTimeoutSeconds()
```
    Number of seconds after which the probe times out.
    Defaults to 1 second. Minimum value is 1.
    Default: Duration.seconds(1)
  - builder
```
@Stability(Stable)
static ProbeOptions.Builder builder()
```
    Returns:
    
    a ProbeOptions.Builder of ProbeOptions