Package k8s.io.api.core.v1

Interface Generated.ProbeOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Generated.Probe, Generated.Probe.Builder
    Enclosing class:
    Generated
    public static interface Generated.ProbeOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getFailureThreshold()
      Minimum consecutive failures for the probe to be considered failed after having succeeded.
      Generated.ProbeHandler getHandler()
      The action taken to determine the health of a container
      Generated.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.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasHandler

        boolean hasHandler()
         The action taken to determine the health of a container
        optional .k8s.io.api.core.v1.ProbeHandler handler = 1;
        Returns:
        Whether the handler field is set.

      • getHandler

        Generated.ProbeHandler getHandler()
         The action taken to determine the health of a container
        optional .k8s.io.api.core.v1.ProbeHandler handler = 1;
        Returns:
        The handler.

      • getHandlerOrBuilder

        Generated.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;
        Returns:
        Whether the initialDelaySeconds field is set.

      • 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;
        Returns:
        The initialDelaySeconds.

      • 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;
        Returns:
        Whether the timeoutSeconds field is set.

      • 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;
        Returns:
        The timeoutSeconds.

      • hasPeriodSeconds

        boolean hasPeriodSeconds()
         How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1.
 +optional
        optional int32 periodSeconds = 4;
        Returns:
        Whether the periodSeconds field is set.

      • getPeriodSeconds

        int getPeriodSeconds()
         How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1.
 +optional
        optional int32 periodSeconds = 4;
        Returns:
        The periodSeconds.

      • 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;
        Returns:
        Whether the successThreshold field is set.

      • 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;
        Returns:
        The successThreshold.

      • 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;
        Returns:
        Whether the failureThreshold field is set.

      • 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;
        Returns:
        The failureThreshold.

      • 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;
        Returns:
        Whether the terminationGracePeriodSeconds field is set.

      • 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;
        Returns:
        The terminationGracePeriodSeconds.