Package io.kubernetes.client.proto

Class V1.Probe.Builder

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

  • Method Details

    • 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.Builder<V1.Probe.Builder>

    • clear

      public V1.Probe.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public V1.Probe.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • setField

      public V1.Probe.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • clearField

      public V1.Probe.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • clearOneof

      public V1.Probe.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • setRepeatedField

      public V1.Probe.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • addRepeatedField

      public V1.Probe.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • mergeFrom

      public V1.Probe.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<V1.Probe.Builder>

    • mergeFrom

      public V1.Probe.Builder mergeFrom(V1.Probe other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • mergeFrom

      public V1.Probe.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<V1.Probe.Builder>
      Throws:
      IOException

    • 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

    • setHandler

      public V1.Probe.Builder setHandler(V1.ProbeHandler value)
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

    • setHandler

      public V1.Probe.Builder setHandler(V1.ProbeHandler.Builder builderForValue)
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

    • mergeHandler

      public V1.Probe.Builder mergeHandler(V1.ProbeHandler value)
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

    • clearHandler

      public V1.Probe.Builder clearHandler()
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

    • getHandlerBuilder

      public V1.ProbeHandler.Builder getHandlerBuilder()
       The action taken to determine the health of a container
      optional .k8s.io.api.core.v1.ProbeHandler handler = 1;

    • 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

    • setInitialDelaySeconds

      public V1.Probe.Builder setInitialDelaySeconds(int value)
       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;

    • clearInitialDelaySeconds

      public V1.Probe.Builder clearInitialDelaySeconds()
       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

      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

    • setTimeoutSeconds

      public V1.Probe.Builder setTimeoutSeconds(int value)
       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;

    • clearTimeoutSeconds

      public V1.Probe.Builder clearTimeoutSeconds()
       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

      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

    • setPeriodSeconds

      public V1.Probe.Builder setPeriodSeconds(int value)
       How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1.
 +optional
      optional int32 periodSeconds = 4;

    • clearPeriodSeconds

      public V1.Probe.Builder clearPeriodSeconds()
       How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1.
 +optional
      optional int32 periodSeconds = 4;

    • 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

    • setSuccessThreshold

      public V1.Probe.Builder setSuccessThreshold(int value)
       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;

    • clearSuccessThreshold

      public V1.Probe.Builder clearSuccessThreshold()
       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

      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

    • setFailureThreshold

      public V1.Probe.Builder setFailureThreshold(int value)
       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;

    • clearFailureThreshold

      public V1.Probe.Builder clearFailureThreshold()
       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

      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

    • setTerminationGracePeriodSeconds

      public V1.Probe.Builder setTerminationGracePeriodSeconds(long value)
       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;

    • clearTerminationGracePeriodSeconds

      public V1.Probe.Builder clearTerminationGracePeriodSeconds()
       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;

    • setUnknownFields

      public final V1.Probe.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>

    • mergeUnknownFields

      public final V1.Probe.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<V1.Probe.Builder>