Package io.micronaut.kubernetes.client.openapi.model

Class V1Probe

java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1Probe
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen") 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

    • getExec

      public V1ExecAction getExec()
      Returns:
      the exec property value

    • setExec

      public void setExec(V1ExecAction exec)
      Set the exec property value
      Parameters:
      exec - property value to set

    • exec

      public V1Probe exec(V1ExecAction exec)
      Set exec in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getFailureThreshold

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

    • setFailureThreshold

      public void setFailureThreshold(Integer failureThreshold)
      Set the failureThreshold property value
      Parameters:
      failureThreshold - property value to set

    • failureThreshold

      public V1Probe failureThreshold(Integer failureThreshold)
      Set failureThreshold in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getGrpc

      public V1GRPCAction getGrpc()
      Returns:
      the grpc property value

    • setGrpc

      public void setGrpc(V1GRPCAction grpc)
      Set the grpc property value
      Parameters:
      grpc - property value to set

    • grpc

      public V1Probe grpc(V1GRPCAction grpc)
      Set grpc in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getHttpGet

      public V1HTTPGetAction getHttpGet()
      Returns:
      the httpGet property value

    • setHttpGet

      public void setHttpGet(V1HTTPGetAction httpGet)
      Set the httpGet property value
      Parameters:
      httpGet - property value to set

    • httpGet

      public V1Probe httpGet(V1HTTPGetAction httpGet)
      Set httpGet in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getInitialDelaySeconds

      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:
      the initialDelaySeconds property value

    • setInitialDelaySeconds

      public void setInitialDelaySeconds(Integer initialDelaySeconds)
      Set the initialDelaySeconds property value
      Parameters:
      initialDelaySeconds - property value to set

    • initialDelaySeconds

      public V1Probe initialDelaySeconds(Integer initialDelaySeconds)
      Set initialDelaySeconds in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getPeriodSeconds

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

    • setPeriodSeconds

      public void setPeriodSeconds(Integer periodSeconds)
      Set the periodSeconds property value
      Parameters:
      periodSeconds - property value to set

    • periodSeconds

      public V1Probe periodSeconds(Integer periodSeconds)
      Set periodSeconds in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getSuccessThreshold

      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:
      the successThreshold property value

    • setSuccessThreshold

      public void setSuccessThreshold(Integer successThreshold)
      Set the successThreshold property value
      Parameters:
      successThreshold - property value to set

    • successThreshold

      public V1Probe successThreshold(Integer successThreshold)
      Set successThreshold in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getTcpSocket

      public V1TCPSocketAction getTcpSocket()
      Returns:
      the tcpSocket property value

    • setTcpSocket

      public void setTcpSocket(V1TCPSocketAction tcpSocket)
      Set the tcpSocket property value
      Parameters:
      tcpSocket - property value to set

    • tcpSocket

      public V1Probe tcpSocket(V1TCPSocketAction tcpSocket)
      Set tcpSocket in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getTerminationGracePeriodSeconds

      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:
      the terminationGracePeriodSeconds property value

    • setTerminationGracePeriodSeconds

      public void setTerminationGracePeriodSeconds(Long terminationGracePeriodSeconds)
      Set the terminationGracePeriodSeconds property value
      Parameters:
      terminationGracePeriodSeconds - property value to set

    • terminationGracePeriodSeconds

      public V1Probe terminationGracePeriodSeconds(Long terminationGracePeriodSeconds)
      Set terminationGracePeriodSeconds in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • getTimeoutSeconds

      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:
      the timeoutSeconds property value

    • setTimeoutSeconds

      public void setTimeoutSeconds(Integer timeoutSeconds)
      Set the timeoutSeconds property value
      Parameters:
      timeoutSeconds - property value to set

    • timeoutSeconds

      public V1Probe timeoutSeconds(Integer timeoutSeconds)
      Set timeoutSeconds in a chainable fashion.
      Returns:
      The same instance of V1Probe for chaining.

    • 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