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 Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
exec
(V1ExecAction exec) Set exec in a chainable fashion.failureThreshold
(Integer failureThreshold) Set failureThreshold in a chainable fashion.getExec()
Minimum consecutive failures for the probe to be considered failed after having succeeded.getGrpc()
Number 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.Optional duration in seconds the pod needs to terminate gracefully upon probe failure.Number of seconds after which the probe times out.grpc
(V1GRPCAction grpc) Set grpc in a chainable fashion.int
hashCode()
httpGet
(V1HTTPGetAction httpGet) Set httpGet in a chainable fashion.initialDelaySeconds
(Integer initialDelaySeconds) Set initialDelaySeconds in a chainable fashion.periodSeconds
(Integer periodSeconds) Set periodSeconds in a chainable fashion.void
setExec
(V1ExecAction exec) Set the exec property valuevoid
setFailureThreshold
(Integer failureThreshold) Set the failureThreshold property valuevoid
setGrpc
(V1GRPCAction grpc) Set the grpc property valuevoid
setHttpGet
(V1HTTPGetAction httpGet) Set the httpGet property valuevoid
setInitialDelaySeconds
(Integer initialDelaySeconds) Set the initialDelaySeconds property valuevoid
setPeriodSeconds
(Integer periodSeconds) Set the periodSeconds property valuevoid
setSuccessThreshold
(Integer successThreshold) Set the successThreshold property valuevoid
setTcpSocket
(V1TCPSocketAction tcpSocket) Set the tcpSocket property valuevoid
setTerminationGracePeriodSeconds
(Long terminationGracePeriodSeconds) Set the terminationGracePeriodSeconds property valuevoid
setTimeoutSeconds
(Integer timeoutSeconds) Set the timeoutSeconds property valuesuccessThreshold
(Integer successThreshold) Set successThreshold in a chainable fashion.tcpSocket
(V1TCPSocketAction tcpSocket) Set tcpSocket in a chainable fashion.terminationGracePeriodSeconds
(Long terminationGracePeriodSeconds) Set terminationGracePeriodSeconds in a chainable fashion.timeoutSeconds
(Integer timeoutSeconds) Set timeoutSeconds in a chainable fashion.toString()
-
Field Details
-
JSON_PROPERTY_EXEC
- See Also:
-
JSON_PROPERTY_FAILURE_THRESHOLD
- See Also:
-
JSON_PROPERTY_GRPC
- See Also:
-
JSON_PROPERTY_HTTP_GET
- See Also:
-
JSON_PROPERTY_INITIAL_DELAY_SECONDS
- See Also:
-
JSON_PROPERTY_PERIOD_SECONDS
- See Also:
-
JSON_PROPERTY_SUCCESS_THRESHOLD
- See Also:
-
JSON_PROPERTY_TCP_SOCKET
- See Also:
-
JSON_PROPERTY_TERMINATION_GRACE_PERIOD_SECONDS
- See Also:
-
JSON_PROPERTY_TIMEOUT_SECONDS
- See Also:
-
-
Constructor Details
-
V1Probe
public V1Probe()
-
-
Method Details
-
getExec
- Returns:
- the exec property value
-
setExec
Set the exec property value -
exec
Set exec in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
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
Set the failureThreshold property value -
failureThreshold
Set failureThreshold in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
getGrpc
- Returns:
- the grpc property value
-
setGrpc
Set the grpc property value -
grpc
Set grpc in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
getHttpGet
- Returns:
- the httpGet property value
-
setHttpGet
Set the httpGet property value -
httpGet
Set httpGet in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
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
Set the initialDelaySeconds property value -
initialDelaySeconds
Set initialDelaySeconds in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
getPeriodSeconds
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.- Returns:
- the periodSeconds property value
-
setPeriodSeconds
Set the periodSeconds property value -
periodSeconds
Set periodSeconds in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
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
Set the successThreshold property value -
successThreshold
Set successThreshold in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
getTcpSocket
- Returns:
- the tcpSocket property value
-
setTcpSocket
Set the tcpSocket property value -
tcpSocket
Set tcpSocket in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
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
Set the terminationGracePeriodSeconds property value -
terminationGracePeriodSeconds
Set terminationGracePeriodSeconds in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
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
Set the timeoutSeconds property value -
timeoutSeconds
Set timeoutSeconds in a chainable fashion.- Returns:
- The same instance of V1Probe for chaining.
-
equals
-
hashCode
public int hashCode() -
toString
-