io.kubernetes.client.openapi.models

Class V1Probe

java.lang.Object

io.kubernetes.client.openapi.models.V1Probe

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-04T09:55:14.976Z[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 Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_EXEC
static String	SERIALIZED_NAME_FAILURE_THRESHOLD
static String	SERIALIZED_NAME_HTTP_GET
static String	SERIALIZED_NAME_INITIAL_DELAY_SECONDS
static String	SERIALIZED_NAME_PERIOD_SECONDS
static String	SERIALIZED_NAME_SUCCESS_THRESHOLD
static String	SERIALIZED_NAME_TCP_SOCKET
static String	SERIALIZED_NAME_TIMEOUT_SECONDS

Constructor Summary

Constructors

Constructor and Description
V1Probe()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
V1Probe	exec(V1ExecAction exec)
V1Probe	failureThreshold(Integer failureThreshold)
V1ExecAction	getExec() Get exec
Integer	getFailureThreshold() Minimum consecutive failures for the probe to be considered failed after having succeeded.
V1HTTPGetAction	getHttpGet() Get httpGet
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.
V1TCPSocketAction	getTcpSocket() Get tcpSocket
Integer	getTimeoutSeconds() Number of seconds after which the probe times out.
int	hashCode()
V1Probe	httpGet(V1HTTPGetAction httpGet)
V1Probe	initialDelaySeconds(Integer initialDelaySeconds)
V1Probe	periodSeconds(Integer periodSeconds)
void	setExec(V1ExecAction exec)
void	setFailureThreshold(Integer failureThreshold)
void	setHttpGet(V1HTTPGetAction httpGet)
void	setInitialDelaySeconds(Integer initialDelaySeconds)
void	setPeriodSeconds(Integer periodSeconds)
void	setSuccessThreshold(Integer successThreshold)
void	setTcpSocket(V1TCPSocketAction tcpSocket)
void	setTimeoutSeconds(Integer timeoutSeconds)
V1Probe	successThreshold(Integer successThreshold)
V1Probe	tcpSocket(V1TCPSocketAction tcpSocket)
V1Probe	timeoutSeconds(Integer timeoutSeconds)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_EXEC

public static final String SERIALIZED_NAME_EXEC

See Also:

Constant Field Values

SERIALIZED_NAME_FAILURE_THRESHOLD

public static final String SERIALIZED_NAME_FAILURE_THRESHOLD

See Also:

Constant Field Values

SERIALIZED_NAME_HTTP_GET

public static final String SERIALIZED_NAME_HTTP_GET

See Also:

Constant Field Values

SERIALIZED_NAME_INITIAL_DELAY_SECONDS

public static final String SERIALIZED_NAME_INITIAL_DELAY_SECONDS

See Also:

Constant Field Values

SERIALIZED_NAME_PERIOD_SECONDS

public static final String SERIALIZED_NAME_PERIOD_SECONDS

See Also:

Constant Field Values

SERIALIZED_NAME_SUCCESS_THRESHOLD

public static final String SERIALIZED_NAME_SUCCESS_THRESHOLD

See Also:

Constant Field Values

SERIALIZED_NAME_TCP_SOCKET

public static final String SERIALIZED_NAME_TCP_SOCKET

See Also:

Constant Field Values

SERIALIZED_NAME_TIMEOUT_SECONDS

public static final String SERIALIZED_NAME_TIMEOUT_SECONDS

See Also:

Constant Field Values

Constructor Detail

V1Probe

public V1Probe()

Method Detail

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)

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)

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