Package io.kubernetes.client.proto

Class V1.Probe

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.kubernetes.client.proto.V1.Probe
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, V1.ProbeOrBuilder, Serializable
Enclosing class:
V1
public static final class V1.Probe extends com.google.protobuf.GeneratedMessageV3 implements V1.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    V1.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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FAILURETHRESHOLD_FIELD_NUMBER
     
    static final int
    HANDLER_FIELD_NUMBER
     
    static final int
    INITIALDELAYSECONDS_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<V1.Probe>
    PARSER
    Deprecated.
    static final int
    PERIODSECONDS_FIELD_NUMBER
     
    static final int
    SUCCESSTHRESHOLD_FIELD_NUMBER
     
    static final int
    TERMINATIONGRACEPERIODSECONDS_FIELD_NUMBER
     
    static final int
    TIMEOUTSECONDS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static V1.Probe
    getDefaultInstance()
     
    V1.Probe
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<V1.Probe>
    getParserForType()
     
    int
    getPeriodSeconds()
    How often (in seconds) to perform the probe.
    int
    getSerializedSize()
     
    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.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    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
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static V1.Probe.Builder
    newBuilder()
     
    static V1.Probe.Builder
    newBuilder(V1.Probe prototype)
     
    V1.Probe.Builder
    newBuilderForType()
     
    protected V1.Probe.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    static V1.Probe
    parseDelimitedFrom(InputStream input)
     
    static V1.Probe
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.Probe
    parseFrom(byte[] data)
     
    static V1.Probe
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.Probe
    parseFrom(com.google.protobuf.ByteString data)
     
    static V1.Probe
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.Probe
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static V1.Probe
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.Probe
    parseFrom(InputStream input)
     
    static V1.Probe
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static V1.Probe
    parseFrom(ByteBuffer data)
     
    static V1.Probe
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<V1.Probe>
    parser()
     
    V1.Probe.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • HANDLER_FIELD_NUMBER

      public static final int HANDLER_FIELD_NUMBER
      See Also:

    • INITIALDELAYSECONDS_FIELD_NUMBER

      public static final int INITIALDELAYSECONDS_FIELD_NUMBER
      See Also:

    • TIMEOUTSECONDS_FIELD_NUMBER

      public static final int TIMEOUTSECONDS_FIELD_NUMBER
      See Also:

    • PERIODSECONDS_FIELD_NUMBER

      public static final int PERIODSECONDS_FIELD_NUMBER
      See Also:

    • SUCCESSTHRESHOLD_FIELD_NUMBER

      public static final int SUCCESSTHRESHOLD_FIELD_NUMBER
      See Also:

    • FAILURETHRESHOLD_FIELD_NUMBER

      public static final int FAILURETHRESHOLD_FIELD_NUMBER
      See Also:

    • TERMINATIONGRACEPERIODSECONDS_FIELD_NUMBER

      public static final int TERMINATIONGRACEPERIODSECONDS_FIELD_NUMBER
      See Also:

    • PARSER

      @Deprecated public static final com.google.protobuf.Parser<V1.Probe> PARSER
      Deprecated.

  • Method Details

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields 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 V1.ProbeOrBuilder

    • getHandler

      public V1.ProbeHandler getHandler()
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;
      Specified by:
      getHandler in interface V1.ProbeOrBuilder

    • getHandlerOrBuilder

      public V1.ProbeHandlerOrBuilder getHandlerOrBuilder()
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;
      Specified by:
      getHandlerOrBuilder in interface V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.ProbeOrBuilder

    • 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 V1.Probe parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static V1.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 V1.Probe parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static V1.Probe parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static V1.Probe parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static V1.Probe parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static V1.Probe parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static V1.Probe parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static V1.Probe.Builder newBuilder()

    • newBuilder

      public static V1.Probe.Builder newBuilder(V1.Probe prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static V1.Probe getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<V1.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 V1.Probe getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder