Class V1Probe
java.lang.Object
io.kubernetes.client.openapi.models.V1Probe
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-02-02T21:37:40.170033Z[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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
exec
(V1ExecAction exec) failureThreshold
(Integer failureThreshold) getExec()
Get execMinimum consecutive failures for the probe to be considered failed after having succeeded.getGrpc()
Get grpcGet httpGetNumber of seconds after the container has started before liveness probes are initiated.How often (in seconds) to perform the probe.Minimum consecutive successes for the probe to be considered successful after having failed.Get tcpSocketOptional duration in seconds the pod needs to terminate gracefully upon probe failure.Number of seconds after which the probe times out.grpc
(V1GRPCAction grpc) int
hashCode()
httpGet
(V1HTTPGetAction httpGet) initialDelaySeconds
(Integer initialDelaySeconds) periodSeconds
(Integer periodSeconds) void
setExec
(V1ExecAction exec) void
setFailureThreshold
(Integer failureThreshold) void
setGrpc
(V1GRPCAction grpc) void
setHttpGet
(V1HTTPGetAction httpGet) void
setInitialDelaySeconds
(Integer initialDelaySeconds) void
setPeriodSeconds
(Integer periodSeconds) void
setSuccessThreshold
(Integer successThreshold) void
setTcpSocket
(V1TCPSocketAction tcpSocket) void
setTerminationGracePeriodSeconds
(Long terminationGracePeriodSeconds) void
setTimeoutSeconds
(Integer timeoutSeconds) successThreshold
(Integer successThreshold) tcpSocket
(V1TCPSocketAction tcpSocket) terminationGracePeriodSeconds
(Long terminationGracePeriodSeconds) timeoutSeconds
(Integer timeoutSeconds) toString()
-
Field Details
-
SERIALIZED_NAME_EXEC
- See Also:
-
SERIALIZED_NAME_FAILURE_THRESHOLD
- See Also:
-
SERIALIZED_NAME_GRPC
- See Also:
-
SERIALIZED_NAME_HTTP_GET
- See Also:
-
SERIALIZED_NAME_INITIAL_DELAY_SECONDS
- See Also:
-
SERIALIZED_NAME_PERIOD_SECONDS
- See Also:
-
SERIALIZED_NAME_SUCCESS_THRESHOLD
- See Also:
-
SERIALIZED_NAME_TCP_SOCKET
- See Also:
-
SERIALIZED_NAME_TERMINATION_GRACE_PERIOD_SECONDS
- See Also:
-
SERIALIZED_NAME_TIMEOUT_SECONDS
- See Also:
-
-
Constructor Details
-
V1Probe
public V1Probe()
-
-
Method Details
-
exec
-
getExec
Get exec- Returns:
- exec
-
setExec
-
failureThreshold
-
getFailureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.- Returns:
- failureThreshold
-
setFailureThreshold
-
grpc
-
getGrpc
Get grpc- Returns:
- grpc
-
setGrpc
-
httpGet
-
getHttpGet
Get httpGet- Returns:
- httpGet
-
setHttpGet
-
initialDelaySeconds
-
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
-
periodSeconds
-
getPeriodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.- Returns:
- periodSeconds
-
setPeriodSeconds
-
successThreshold
-
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
-
tcpSocket
-
getTcpSocket
Get tcpSocket- Returns:
- tcpSocket
-
setTcpSocket
-
terminationGracePeriodSeconds
-
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
-
timeoutSeconds
-
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
-
equals
-
hashCode
public int hashCode() -
toString
-