Package k8s.io.api.core.v1

Class Generated.Probe

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Generated.ProbeOrBuilder
    Enclosing class:
    Generated
    public static final class Generated.Probe
extends com.google.protobuf.GeneratedMessageV3
implements Generated.ProbeOrBuilder
     Probe describes a health check to be performed against a container to determine whether it is
 alive or ready to receive traffic.
    Protobuf type k8s.io.api.core.v1.Probe
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Generated.Probe.Builder
      Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • INITIALDELAYSECONDS_FIELD_NUMBER

        public static final int INITIALDELAYSECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMEOUTSECONDS_FIELD_NUMBER

        public static final int TIMEOUTSECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERIODSECONDS_FIELD_NUMBER

        public static final int PERIODSECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUCCESSTHRESHOLD_FIELD_NUMBER

        public static final int SUCCESSTHRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAILURETHRESHOLD_FIELD_NUMBER

        public static final int FAILURETHRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TERMINATIONGRACEPERIODSECONDS_FIELD_NUMBER

        public static final int TERMINATIONGRACEPERIODSECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasHandler

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

      • hasInitialDelaySeconds

        public 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;
        Specified by:
        hasInitialDelaySeconds in interface Generated.ProbeOrBuilder
        Returns:
        Whether the initialDelaySeconds field is set.

      • getInitialDelaySeconds

        public 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;
        Specified by:
        getInitialDelaySeconds in interface Generated.ProbeOrBuilder
        Returns:
        The initialDelaySeconds.

      • hasTimeoutSeconds

        public 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;
        Specified by:
        hasTimeoutSeconds in interface Generated.ProbeOrBuilder
        Returns:
        Whether the timeoutSeconds field is set.

      • getTimeoutSeconds

        public 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;
        Specified by:
        getTimeoutSeconds in interface Generated.ProbeOrBuilder
        Returns:
        The timeoutSeconds.

      • hasPeriodSeconds

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

      • getPeriodSeconds

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

      • hasSuccessThreshold

        public 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;
        Specified by:
        hasSuccessThreshold in interface Generated.ProbeOrBuilder
        Returns:
        Whether the successThreshold field is set.

      • getSuccessThreshold

        public 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;
        Specified by:
        getSuccessThreshold in interface Generated.ProbeOrBuilder
        Returns:
        The successThreshold.

      • hasFailureThreshold

        public 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;
        Specified by:
        hasFailureThreshold in interface Generated.ProbeOrBuilder
        Returns:
        Whether the failureThreshold field is set.

      • getFailureThreshold

        public 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;
        Specified by:
        getFailureThreshold in interface Generated.ProbeOrBuilder
        Returns:
        The failureThreshold.

      • hasTerminationGracePeriodSeconds

        public 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;
        Specified by:
        hasTerminationGracePeriodSeconds in interface Generated.ProbeOrBuilder
        Returns:
        Whether the terminationGracePeriodSeconds field is set.

      • getTerminationGracePeriodSeconds

        public 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;
        Specified by:
        getTerminationGracePeriodSeconds in interface Generated.ProbeOrBuilder
        Returns:
        The terminationGracePeriodSeconds.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Generated.Probe parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Probe parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Probe parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Probe parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Probe parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Probe parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Generated.Probe parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Generated.Probe.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Generated.Probe.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Generated.Probe.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<Generated.Probe> parser()

      • getParserForType

        public com.google.protobuf.Parser<Generated.Probe> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Generated.Probe getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder