io.kubernetes.client.proto

Interface V1.ProbeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

V1.Probe, V1.Probe.Builder

Enclosing class:

V1

public static interface V1.ProbeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getFailureThreshold() Minimum consecutive failures for the probe to be considered failed after having succeeded.
V1.ProbeHandler	getHandler() The action taken to determine the health of a container
V1.ProbeHandlerOrBuilder	getHandlerOrBuilder() The action taken to determine the health of a container
int	getInitialDelaySeconds() Number of seconds after the container has started before liveness probes are initiated.
int	getPeriodSeconds() How often (in seconds) to perform the probe.
int	getSuccessThreshold() Minimum consecutive successes for the probe to be considered successful after having failed.
long	getTerminationGracePeriodSeconds() Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
int	getTimeoutSeconds() Number of seconds after which the probe times out.
boolean	hasFailureThreshold() Minimum consecutive failures for the probe to be considered failed after having succeeded.
boolean	hasHandler() The action taken to determine the health of a container
boolean	hasInitialDelaySeconds() Number of seconds after the container has started before liveness probes are initiated.
boolean	hasPeriodSeconds() How often (in seconds) to perform the probe.
boolean	hasSuccessThreshold() Minimum consecutive successes for the probe to be considered successful after having failed.
boolean	hasTerminationGracePeriodSeconds() Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
boolean	hasTimeoutSeconds() Number of seconds after which the probe times out.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasHandler

boolean hasHandler()

 The action taken to determine the health of a container
 

optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

getHandler

V1.ProbeHandler getHandler()

 The action taken to determine the health of a container
 

optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

getHandlerOrBuilder

V1.ProbeHandlerOrBuilder getHandlerOrBuilder()

 The action taken to determine the health of a container
 

optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

hasInitialDelaySeconds

boolean hasInitialDelaySeconds()

 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
 +optional
 

optional int32 initialDelaySeconds = 2;

getInitialDelaySeconds

int 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
 +optional
 

optional int32 initialDelaySeconds = 2;

hasTimeoutSeconds

boolean hasTimeoutSeconds()

 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
 +optional
 

optional int32 timeoutSeconds = 3;

getTimeoutSeconds

int 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
 +optional
 

optional int32 timeoutSeconds = 3;

hasPeriodSeconds

boolean hasPeriodSeconds()

 How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1.
 +optional
 

optional int32 periodSeconds = 4;

getPeriodSeconds

int getPeriodSeconds()

 How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1.
 +optional
 

optional int32 periodSeconds = 4;

hasSuccessThreshold

boolean hasSuccessThreshold()

 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.
 +optional
 

optional int32 successThreshold = 5;

getSuccessThreshold

int 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.
 +optional
 

optional int32 successThreshold = 5;

hasFailureThreshold

boolean hasFailureThreshold()

 Minimum consecutive failures for the probe to be considered failed after having succeeded.
 Defaults to 3. Minimum value is 1.
 +optional
 

optional int32 failureThreshold = 6;

getFailureThreshold

int getFailureThreshold()

 Minimum consecutive failures for the probe to be considered failed after having succeeded.
 Defaults to 3. Minimum value is 1.
 +optional
 

optional int32 failureThreshold = 6;

hasTerminationGracePeriodSeconds

boolean hasTerminationGracePeriodSeconds()

 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.
 +optional
 

optional int64 terminationGracePeriodSeconds = 7;

getTerminationGracePeriodSeconds

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.
 +optional
 

optional int64 terminationGracePeriodSeconds = 7;