io.k8s.api.core.v1.Probe Maven / Gradle / Ivy

Go to download
package io.k8s.api.core.v1;

import java.lang.Long;

/**
 * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
 */
public class Probe {
  public ExecAction exec;

  public Long failureThreshold;

  public GRPCAction grpc;

  public HTTPGetAction httpGet;

  public Long initialDelaySeconds;

  public Long periodSeconds;

  public Long successThreshold;

  public TCPSocketAction tcpSocket;

  public Long terminationGracePeriodSeconds;

  public Long timeoutSeconds;

  public Probe exec(ExecAction exec) {
    this.exec = exec;
    return this;
  }

  /**
   * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
   */
  public Probe failureThreshold(Long failureThreshold) {
    this.failureThreshold = failureThreshold;
    return this;
  }

  public Probe grpc(GRPCAction grpc) {
    this.grpc = grpc;
    return this;
  }

  public Probe httpGet(HTTPGetAction httpGet) {
    this.httpGet = httpGet;
    return this;
  }

  /**
   * 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
   */
  public Probe initialDelaySeconds(Long initialDelaySeconds) {
    this.initialDelaySeconds = initialDelaySeconds;
    return this;
  }

  /**
   * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
   */
  public Probe periodSeconds(Long periodSeconds) {
    this.periodSeconds = periodSeconds;
    return this;
  }

  /**
   * 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.
   */
  public Probe successThreshold(Long successThreshold) {
    this.successThreshold = successThreshold;
    return this;
  }

  public Probe tcpSocket(TCPSocketAction tcpSocket) {
    this.tcpSocket = tcpSocket;
    return this;
  }

  /**
   * 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.
   */
  public Probe terminationGracePeriodSeconds(Long terminationGracePeriodSeconds) {
    this.terminationGracePeriodSeconds = terminationGracePeriodSeconds;
    return this;
  }

  /**
   * 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
   */
  public Probe timeoutSeconds(Long timeoutSeconds) {
    this.timeoutSeconds = timeoutSeconds;
    return this;
  }

  public static Probe probe() {
    return new Probe();
  }
}