Class Probe.Jsii$Proxy

  • All Implemented Interfaces:
    Probe, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    Probe

    @Stability(Stable)
    @Internal
    public static final class Probe.Jsii$Proxy
    extends software.amazon.jsii.JsiiObject
    implements Probe
    An implementation for Probe
    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.
      • Jsii$Proxy

        protected Jsii$Proxy​(Probe.Builder builder)
        Constructor that initializes the object based on literal property values passed by the Probe.Builder.
    • Method Detail

      • getExec

        public final ExecAction getExec()
        Description copied from interface: Probe
        Exec specifies the action to take.
        Specified by:
        getExec in interface Probe
      • getFailureThreshold

        public final Number getFailureThreshold()
        Description copied from interface: Probe
        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.

        Specified by:
        getFailureThreshold in interface Probe
      • getGrpc

        public final GrpcAction getGrpc()
        Description copied from interface: Probe
        GRPC specifies an action involving a GRPC port.

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

        Specified by:
        getGrpc in interface Probe
      • getHttpGet

        public final HttpGetAction getHttpGet()
        Description copied from interface: Probe
        HTTPGet specifies the http request to perform.
        Specified by:
        getHttpGet in interface Probe
      • getInitialDelaySeconds

        public final Number getInitialDelaySeconds()
        Description copied from interface: Probe
        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

        Specified by:
        getInitialDelaySeconds in interface Probe
      • getPeriodSeconds

        public final Number getPeriodSeconds()
        Description copied from interface: Probe
        How often (in seconds) to perform the probe.

        Default to 10 seconds. Minimum value is 1.

        Default: 10 seconds. Minimum value is 1.

        Specified by:
        getPeriodSeconds in interface Probe
      • getSuccessThreshold

        public final Number getSuccessThreshold()
        Description copied from interface: Probe
        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.

        Specified by:
        getSuccessThreshold in interface Probe
      • getTcpSocket

        public final TcpSocketAction getTcpSocket()
        Description copied from interface: Probe
        TCPSocket specifies an action involving a TCP port.
        Specified by:
        getTcpSocket in interface Probe
      • getTerminationGracePeriodSeconds

        public final Number getTerminationGracePeriodSeconds()
        Description copied from interface: Probe
        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.

        Specified by:
        getTerminationGracePeriodSeconds in interface Probe
      • getTimeoutSeconds

        public final Number getTimeoutSeconds()
        Description copied from interface: Probe
        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

        Specified by:
        getTimeoutSeconds in interface Probe
      • $jsii$toJson

        @Internal
        public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object