Package org.cdk8s.plus24.k8s

Class Probe.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Probe>
    Enclosing interface:
    Probe
    @Stability(Stable)
public static final class Probe.Builder
extends Object
implements software.amazon.jsii.Builder<Probe>
    A builder for Probe

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • failureThreshold

        @Stability(Stable)
public Probe.Builder failureThreshold​(Number failureThreshold)
        Sets the value of Probe.getFailureThreshold()
        Parameters:
        failureThreshold - Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
        Returns:
        this

      • grpc

        @Stability(Stable)
public Probe.Builder grpc​(GrpcAction grpc)
        Sets the value of Probe.getGrpc()
        Parameters:
        grpc - GRPC specifies an action involving a GRPC port. This is a beta field and requires enabling GRPCContainerProbe feature gate.
        Returns:
        this

      • initialDelaySeconds

        @Stability(Stable)
public Probe.Builder initialDelaySeconds​(Number initialDelaySeconds)
        Sets the value of Probe.getInitialDelaySeconds()
        Parameters:
        initialDelaySeconds - 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
        Returns:
        this

      • periodSeconds

        @Stability(Stable)
public Probe.Builder periodSeconds​(Number periodSeconds)
        Sets the value of Probe.getPeriodSeconds()
        Parameters:
        periodSeconds - How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
        Returns:
        this

      • successThreshold

        @Stability(Stable)
public Probe.Builder successThreshold​(Number successThreshold)
        Sets the value of Probe.getSuccessThreshold()
        Parameters:
        successThreshold - 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.
        Returns:
        this

      • terminationGracePeriodSeconds

        @Stability(Stable)
public Probe.Builder terminationGracePeriodSeconds​(Number terminationGracePeriodSeconds)
        Sets the value of Probe.getTerminationGracePeriodSeconds()
        Parameters:
        terminationGracePeriodSeconds - 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.
        Returns:
        this

      • timeoutSeconds

        @Stability(Stable)
public Probe.Builder timeoutSeconds​(Number timeoutSeconds)
        Sets the value of Probe.getTimeoutSeconds()
        Parameters:
        timeoutSeconds - 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
        Returns:
        this

      • build

        @Stability(Stable)
public Probe build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<Probe>
        Returns:
        a new instance of Probe
        Throws:
        NullPointerException - if any required attribute was not provided