Package io.kubernetes.client.openapi.models

Class V1Probe

java.lang.Object
io.kubernetes.client.openapi.models.V1Probe
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-04-23T13:45:09.091597Z[Etc/UTC]") public class V1Probe extends Object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

  • Field Details

  • Constructor Details

    • V1Probe

      public V1Probe()

  • Method Details

    • exec

      public V1Probe exec(V1ExecAction exec)

    • getExec

      @Nullable public V1ExecAction getExec()
      Get exec
      Returns:
      exec

    • setExec

      public void setExec(V1ExecAction exec)

    • failureThreshold

      public V1Probe failureThreshold(Integer failureThreshold)

    • getFailureThreshold

      @Nullable public Integer getFailureThreshold()
      Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
      Returns:
      failureThreshold

    • setFailureThreshold

      public void setFailureThreshold(Integer failureThreshold)

    • grpc

      public V1Probe grpc(V1GRPCAction grpc)

    • getGrpc

      @Nullable public V1GRPCAction getGrpc()
      Get grpc
      Returns:
      grpc

    • setGrpc

      public void setGrpc(V1GRPCAction grpc)

    • httpGet

      public V1Probe httpGet(V1HTTPGetAction httpGet)

    • getHttpGet

      @Nullable public V1HTTPGetAction getHttpGet()
      Get httpGet
      Returns:
      httpGet

    • setHttpGet

      public void setHttpGet(V1HTTPGetAction httpGet)

    • initialDelaySeconds

      public V1Probe initialDelaySeconds(Integer initialDelaySeconds)

    • getInitialDelaySeconds

      @Nullable public Integer 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
      Returns:
      initialDelaySeconds

    • setInitialDelaySeconds

      public void setInitialDelaySeconds(Integer initialDelaySeconds)

    • periodSeconds

      public V1Probe periodSeconds(Integer periodSeconds)

    • getPeriodSeconds

      @Nullable public Integer getPeriodSeconds()
      How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
      Returns:
      periodSeconds

    • setPeriodSeconds

      public void setPeriodSeconds(Integer periodSeconds)

    • successThreshold

      public V1Probe successThreshold(Integer successThreshold)

    • getSuccessThreshold

      @Nullable public Integer 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.
      Returns:
      successThreshold

    • setSuccessThreshold

      public void setSuccessThreshold(Integer successThreshold)

    • tcpSocket

      public V1Probe tcpSocket(V1TCPSocketAction tcpSocket)

    • getTcpSocket

      @Nullable public V1TCPSocketAction getTcpSocket()
      Get tcpSocket
      Returns:
      tcpSocket

    • setTcpSocket

      public void setTcpSocket(V1TCPSocketAction tcpSocket)

    • terminationGracePeriodSeconds

      public V1Probe terminationGracePeriodSeconds(Long terminationGracePeriodSeconds)

    • getTerminationGracePeriodSeconds

      @Nullable public Long 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.
      Returns:
      terminationGracePeriodSeconds

    • setTerminationGracePeriodSeconds

      public void setTerminationGracePeriodSeconds(Long terminationGracePeriodSeconds)

    • timeoutSeconds

      public V1Probe timeoutSeconds(Integer timeoutSeconds)

    • getTimeoutSeconds

      @Nullable public Integer 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
      Returns:
      timeoutSeconds

    • setTimeoutSeconds

      public void setTimeoutSeconds(Integer timeoutSeconds)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonObject

      public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
      Validates the JSON Object and throws an exception if issues found
      Parameters:
      jsonObj - JSON Object
      Throws:
      IOException - if the JSON Object is invalid with respect to V1Probe

    • fromJson

      public static V1Probe fromJson(String jsonString) throws IOException
      Create an instance of V1Probe given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of V1Probe
      Throws:
      IOException - if the JSON string is invalid with respect to V1Probe

    • toJson

      public String toJson()
      Convert an instance of V1Probe to an JSON string
      Returns:
      JSON string