Package com.marcnuri.yakc.model.io.k8s.api.core.v1

Class Probe

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model
    public class Probe
extends java.lang.Object
implements com.marcnuri.yakc.model.Model
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

    • Constructor Detail

      • Probe

        public Probe​(ExecAction exec,
             java.lang.Number failureThreshold,
             GRPCAction grpc,
             HTTPGetAction httpGet,
             java.lang.Number initialDelaySeconds,
             java.lang.Number periodSeconds,
             java.lang.Number successThreshold,
             TCPSocketAction tcpSocket,
             java.lang.Number terminationGracePeriodSeconds,
             java.lang.Number timeoutSeconds)

      • Probe

        public Probe()

    • Method Detail

      • getFailureThreshold

        public java.lang.Number getFailureThreshold()
        Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

      • getInitialDelaySeconds

        public java.lang.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

        public java.lang.Number getPeriodSeconds()
        How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

      • getSuccessThreshold

        public java.lang.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.

      • getTerminationGracePeriodSeconds

        public java.lang.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

        public java.lang.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

      • setExec

        public void setExec​(ExecAction exec)

      • setFailureThreshold

        public void setFailureThreshold​(java.lang.Number failureThreshold)
        Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

      • setGrpc

        public void setGrpc​(GRPCAction grpc)

      • setInitialDelaySeconds

        public void setInitialDelaySeconds​(java.lang.Number 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

      • setPeriodSeconds

        public void setPeriodSeconds​(java.lang.Number periodSeconds)
        How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

      • setSuccessThreshold

        public void setSuccessThreshold​(java.lang.Number 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.

      • setTerminationGracePeriodSeconds

        public void setTerminationGracePeriodSeconds​(java.lang.Number 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.

      • setTimeoutSeconds

        public void setTimeoutSeconds​(java.lang.Number 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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object