java.lang.Object
- io.fabric8.kubernetes.api.model.Probe

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<ProbeBuilder>, KubernetesResource, Serializable
```
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Probe
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ProbeBuilder>, KubernetesResource
```
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`Probe()`	No args constructor for use in serialization
`Probe(ExecAction exec, Integer failureThreshold, GRPCAction grpc, HTTPGetAction httpGet, Integer initialDelaySeconds, Integer periodSeconds, Integer successThreshold, TCPSocketAction tcpSocket, Long terminationGracePeriodSeconds, Integer timeoutSeconds)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ProbeBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`ExecAction`	`getExec()`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`Integer`	`getFailureThreshold()`	Minimum consecutive failures for the probe to be considered failed after having succeeded.
`GRPCAction`	`getGrpc()`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`HTTPGetAction`	`getHttpGet()`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`Integer`	`getInitialDelaySeconds()`	Number of seconds after the container has started before liveness probes are initiated.
`Integer`	`getPeriodSeconds()`	How often (in seconds) to perform the probe.
`Integer`	`getSuccessThreshold()`	Minimum consecutive successes for the probe to be considered successful after having failed.
`TCPSocketAction`	`getTcpSocket()`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`Long`	`getTerminationGracePeriodSeconds()`	Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
`Integer`	`getTimeoutSeconds()`	Number of seconds after which the probe times out.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setExec(ExecAction exec)`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`void`	`setFailureThreshold(Integer failureThreshold)`	Minimum consecutive failures for the probe to be considered failed after having succeeded.
`void`	`setGrpc(GRPCAction grpc)`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`void`	`setHttpGet(HTTPGetAction httpGet)`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`void`	`setInitialDelaySeconds(Integer initialDelaySeconds)`	Number of seconds after the container has started before liveness probes are initiated.
`void`	`setPeriodSeconds(Integer periodSeconds)`	How often (in seconds) to perform the probe.
`void`	`setSuccessThreshold(Integer successThreshold)`	Minimum consecutive successes for the probe to be considered successful after having failed.
`void`	`setTcpSocket(TCPSocketAction tcpSocket)`	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
`void`	`setTerminationGracePeriodSeconds(Long terminationGracePeriodSeconds)`	Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
`void`	`setTimeoutSeconds(Integer timeoutSeconds)`	Number of seconds after which the probe times out.
`ProbeBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Probe
```
public Probe()
```
    No args constructor for use in serialization
  - Probe
```
public Probe(ExecAction exec,
             Integer failureThreshold,
             GRPCAction grpc,
             HTTPGetAction httpGet,
             Integer initialDelaySeconds,
             Integer periodSeconds,
             Integer successThreshold,
             TCPSocketAction tcpSocket,
             Long terminationGracePeriodSeconds,
             Integer timeoutSeconds)
```
- Method Detail
  - getExec
```
public ExecAction getExec()
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - setExec
```
public void setExec(ExecAction exec)
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - getFailureThreshold
```
public Integer getFailureThreshold()
```
    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
  - setFailureThreshold
```
public void setFailureThreshold(Integer failureThreshold)
```
    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
  - getGrpc
```
public GRPCAction getGrpc()
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - setGrpc
```
public void setGrpc(GRPCAction grpc)
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - getHttpGet
```
public HTTPGetAction getHttpGet()
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - setHttpGet
```
public void setHttpGet(HTTPGetAction httpGet)
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - 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
  - setInitialDelaySeconds
```
public void setInitialDelaySeconds(Integer 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
  - getPeriodSeconds
```
public Integer getPeriodSeconds()
```
    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
  - setPeriodSeconds
```
public void setPeriodSeconds(Integer periodSeconds)
```
    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
  - 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.
  - setSuccessThreshold
```
public void setSuccessThreshold(Integer 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.
  - getTcpSocket
```
public TCPSocketAction getTcpSocket()
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - setTcpSocket
```
public void setTcpSocket(TCPSocketAction tcpSocket)
```
    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
  - 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.
  - setTerminationGracePeriodSeconds
```
public void setTerminationGracePeriodSeconds(Long 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.
  - 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
  - setTimeoutSeconds
```
public void setTimeoutSeconds(Integer 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
  - edit
```
public ProbeBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<ProbeBuilder>
  - toBuilder
```
public ProbeBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class Probe

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Probe

Probe

Method Detail

getExec

setExec

getFailureThreshold

setFailureThreshold

getGrpc

setGrpc

getHttpGet

setHttpGet

getInitialDelaySeconds

setInitialDelaySeconds

getPeriodSeconds

setPeriodSeconds

getSuccessThreshold

setSuccessThreshold

getTcpSocket

setTcpSocket

getTerminationGracePeriodSeconds

setTerminationGracePeriodSeconds

getTimeoutSeconds

setTimeoutSeconds

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties