Package io.kubernetes.client.proto

Class V1beta1Apps.StatefulSetSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.kubernetes.client.proto.V1beta1Apps.StatefulSetSpec
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, V1beta1Apps.StatefulSetSpecOrBuilder, Serializable
Enclosing class:
V1beta1Apps
public static final class V1beta1Apps.StatefulSetSpec extends com.google.protobuf.GeneratedMessageV3 implements V1beta1Apps.StatefulSetSpecOrBuilder
 A StatefulSetSpec is the specification of a StatefulSet.
Protobuf type k8s.io.api.apps.v1beta1.StatefulSetSpec
See Also:

  • Field Details

    • REPLICAS_FIELD_NUMBER

      public static final int REPLICAS_FIELD_NUMBER
      See Also:

    • SELECTOR_FIELD_NUMBER

      public static final int SELECTOR_FIELD_NUMBER
      See Also:

    • TEMPLATE_FIELD_NUMBER

      public static final int TEMPLATE_FIELD_NUMBER
      See Also:

    • VOLUMECLAIMTEMPLATES_FIELD_NUMBER

      public static final int VOLUMECLAIMTEMPLATES_FIELD_NUMBER
      See Also:

    • SERVICENAME_FIELD_NUMBER

      public static final int SERVICENAME_FIELD_NUMBER
      See Also:

    • PODMANAGEMENTPOLICY_FIELD_NUMBER

      public static final int PODMANAGEMENTPOLICY_FIELD_NUMBER
      See Also:

    • UPDATESTRATEGY_FIELD_NUMBER

      public static final int UPDATESTRATEGY_FIELD_NUMBER
      See Also:

    • REVISIONHISTORYLIMIT_FIELD_NUMBER

      public static final int REVISIONHISTORYLIMIT_FIELD_NUMBER
      See Also:

    • MINREADYSECONDS_FIELD_NUMBER

      public static final int MINREADYSECONDS_FIELD_NUMBER
      See Also:

    • PARSER

      @Deprecated public static final com.google.protobuf.Parser<V1beta1Apps.StatefulSetSpec> 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

    • hasReplicas

      public boolean hasReplicas()
       replicas is the desired number of replicas of the given Template.
 These are replicas in the sense that they are instantiations of the
 same Template, but individual replicas also have a consistent identity.
 If unspecified, defaults to 1.
 TODO: Consider a rename of this field.
 +optional
      optional int32 replicas = 1;
      Specified by:
      hasReplicas in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getReplicas

      public int getReplicas()
       replicas is the desired number of replicas of the given Template.
 These are replicas in the sense that they are instantiations of the
 same Template, but individual replicas also have a consistent identity.
 If unspecified, defaults to 1.
 TODO: Consider a rename of this field.
 +optional
      optional int32 replicas = 1;
      Specified by:
      getReplicas in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasSelector

      public boolean hasSelector()
       selector is a label query over pods that should match the replica count.
 If empty, defaulted to labels on the pod template.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 +optional
      optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
      Specified by:
      hasSelector in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getSelector

      public Meta.LabelSelector getSelector()
       selector is a label query over pods that should match the replica count.
 If empty, defaulted to labels on the pod template.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 +optional
      optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
      Specified by:
      getSelector in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getSelectorOrBuilder

      public Meta.LabelSelectorOrBuilder getSelectorOrBuilder()
       selector is a label query over pods that should match the replica count.
 If empty, defaulted to labels on the pod template.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 +optional
      optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
      Specified by:
      getSelectorOrBuilder in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasTemplate

      public boolean hasTemplate()
       template is the object that describes the pod that will be created if
 insufficient replicas are detected. Each pod stamped out by the StatefulSet
 will fulfill this Template, but have a unique identity from the rest
 of the StatefulSet.
      optional .k8s.io.api.core.v1.PodTemplateSpec template = 3;
      Specified by:
      hasTemplate in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getTemplate

      public V1.PodTemplateSpec getTemplate()
       template is the object that describes the pod that will be created if
 insufficient replicas are detected. Each pod stamped out by the StatefulSet
 will fulfill this Template, but have a unique identity from the rest
 of the StatefulSet.
      optional .k8s.io.api.core.v1.PodTemplateSpec template = 3;
      Specified by:
      getTemplate in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getTemplateOrBuilder

      public V1.PodTemplateSpecOrBuilder getTemplateOrBuilder()
       template is the object that describes the pod that will be created if
 insufficient replicas are detected. Each pod stamped out by the StatefulSet
 will fulfill this Template, but have a unique identity from the rest
 of the StatefulSet.
      optional .k8s.io.api.core.v1.PodTemplateSpec template = 3;
      Specified by:
      getTemplateOrBuilder in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getVolumeClaimTemplatesList

      public List<V1.PersistentVolumeClaim> getVolumeClaimTemplatesList()
       volumeClaimTemplates is a list of claims that pods are allowed to reference.
 The StatefulSet controller is responsible for mapping network identities to
 claims in a way that maintains the identity of a pod. Every claim in
 this list must have at least one matching (by name) volumeMount in one
 container in the template. A claim in this list takes precedence over
 any volumes in the template, with the same name.
 TODO: Define the behavior if a claim already exists with the same name.
 +optional
      repeated .k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
      Specified by:
      getVolumeClaimTemplatesList in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getVolumeClaimTemplatesOrBuilderList

      public List<? extends V1.PersistentVolumeClaimOrBuilder> getVolumeClaimTemplatesOrBuilderList()
       volumeClaimTemplates is a list of claims that pods are allowed to reference.
 The StatefulSet controller is responsible for mapping network identities to
 claims in a way that maintains the identity of a pod. Every claim in
 this list must have at least one matching (by name) volumeMount in one
 container in the template. A claim in this list takes precedence over
 any volumes in the template, with the same name.
 TODO: Define the behavior if a claim already exists with the same name.
 +optional
      repeated .k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
      Specified by:
      getVolumeClaimTemplatesOrBuilderList in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getVolumeClaimTemplatesCount

      public int getVolumeClaimTemplatesCount()
       volumeClaimTemplates is a list of claims that pods are allowed to reference.
 The StatefulSet controller is responsible for mapping network identities to
 claims in a way that maintains the identity of a pod. Every claim in
 this list must have at least one matching (by name) volumeMount in one
 container in the template. A claim in this list takes precedence over
 any volumes in the template, with the same name.
 TODO: Define the behavior if a claim already exists with the same name.
 +optional
      repeated .k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
      Specified by:
      getVolumeClaimTemplatesCount in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getVolumeClaimTemplates

      public V1.PersistentVolumeClaim getVolumeClaimTemplates(int index)
       volumeClaimTemplates is a list of claims that pods are allowed to reference.
 The StatefulSet controller is responsible for mapping network identities to
 claims in a way that maintains the identity of a pod. Every claim in
 this list must have at least one matching (by name) volumeMount in one
 container in the template. A claim in this list takes precedence over
 any volumes in the template, with the same name.
 TODO: Define the behavior if a claim already exists with the same name.
 +optional
      repeated .k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
      Specified by:
      getVolumeClaimTemplates in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getVolumeClaimTemplatesOrBuilder

      public V1.PersistentVolumeClaimOrBuilder getVolumeClaimTemplatesOrBuilder(int index)
       volumeClaimTemplates is a list of claims that pods are allowed to reference.
 The StatefulSet controller is responsible for mapping network identities to
 claims in a way that maintains the identity of a pod. Every claim in
 this list must have at least one matching (by name) volumeMount in one
 container in the template. A claim in this list takes precedence over
 any volumes in the template, with the same name.
 TODO: Define the behavior if a claim already exists with the same name.
 +optional
      repeated .k8s.io.api.core.v1.PersistentVolumeClaim volumeClaimTemplates = 4;
      Specified by:
      getVolumeClaimTemplatesOrBuilder in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasServiceName

      public boolean hasServiceName()
       serviceName is the name of the service that governs this StatefulSet.
 This service must exist before the StatefulSet, and is responsible for
 the network identity of the set. Pods get DNS/hostnames that follow the
 pattern: pod-specific-string.serviceName.default.svc.cluster.local
 where "pod-specific-string" is managed by the StatefulSet controller.
      optional string serviceName = 5;
      Specified by:
      hasServiceName in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getServiceName

      public String getServiceName()
       serviceName is the name of the service that governs this StatefulSet.
 This service must exist before the StatefulSet, and is responsible for
 the network identity of the set. Pods get DNS/hostnames that follow the
 pattern: pod-specific-string.serviceName.default.svc.cluster.local
 where "pod-specific-string" is managed by the StatefulSet controller.
      optional string serviceName = 5;
      Specified by:
      getServiceName in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getServiceNameBytes

      public com.google.protobuf.ByteString getServiceNameBytes()
       serviceName is the name of the service that governs this StatefulSet.
 This service must exist before the StatefulSet, and is responsible for
 the network identity of the set. Pods get DNS/hostnames that follow the
 pattern: pod-specific-string.serviceName.default.svc.cluster.local
 where "pod-specific-string" is managed by the StatefulSet controller.
      optional string serviceName = 5;
      Specified by:
      getServiceNameBytes in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasPodManagementPolicy

      public boolean hasPodManagementPolicy()
       podManagementPolicy controls how pods are created during initial scale up,
 when replacing pods on nodes, or when scaling down. The default policy is
 `OrderedReady`, where pods are created in increasing order (pod-0, then
 pod-1, etc) and the controller will wait until each pod is ready before
 continuing. When scaling down, the pods are removed in the opposite order.
 The alternative policy is `Parallel` which will create pods in parallel
 to match the desired scale without waiting, and on scale down will delete
 all pods at once.
 +optional
      optional string podManagementPolicy = 6;
      Specified by:
      hasPodManagementPolicy in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getPodManagementPolicy

      public String getPodManagementPolicy()
       podManagementPolicy controls how pods are created during initial scale up,
 when replacing pods on nodes, or when scaling down. The default policy is
 `OrderedReady`, where pods are created in increasing order (pod-0, then
 pod-1, etc) and the controller will wait until each pod is ready before
 continuing. When scaling down, the pods are removed in the opposite order.
 The alternative policy is `Parallel` which will create pods in parallel
 to match the desired scale without waiting, and on scale down will delete
 all pods at once.
 +optional
      optional string podManagementPolicy = 6;
      Specified by:
      getPodManagementPolicy in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getPodManagementPolicyBytes

      public com.google.protobuf.ByteString getPodManagementPolicyBytes()
       podManagementPolicy controls how pods are created during initial scale up,
 when replacing pods on nodes, or when scaling down. The default policy is
 `OrderedReady`, where pods are created in increasing order (pod-0, then
 pod-1, etc) and the controller will wait until each pod is ready before
 continuing. When scaling down, the pods are removed in the opposite order.
 The alternative policy is `Parallel` which will create pods in parallel
 to match the desired scale without waiting, and on scale down will delete
 all pods at once.
 +optional
      optional string podManagementPolicy = 6;
      Specified by:
      getPodManagementPolicyBytes in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasUpdateStrategy

      public boolean hasUpdateStrategy()
       updateStrategy indicates the StatefulSetUpdateStrategy that will be
 employed to update Pods in the StatefulSet when a revision is made to
 Template.
      optional .k8s.io.api.apps.v1beta1.StatefulSetUpdateStrategy updateStrategy = 7;
      Specified by:
      hasUpdateStrategy in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getUpdateStrategy

      public V1beta1Apps.StatefulSetUpdateStrategy getUpdateStrategy()
       updateStrategy indicates the StatefulSetUpdateStrategy that will be
 employed to update Pods in the StatefulSet when a revision is made to
 Template.
      optional .k8s.io.api.apps.v1beta1.StatefulSetUpdateStrategy updateStrategy = 7;
      Specified by:
      getUpdateStrategy in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getUpdateStrategyOrBuilder

      public V1beta1Apps.StatefulSetUpdateStrategyOrBuilder getUpdateStrategyOrBuilder()
       updateStrategy indicates the StatefulSetUpdateStrategy that will be
 employed to update Pods in the StatefulSet when a revision is made to
 Template.
      optional .k8s.io.api.apps.v1beta1.StatefulSetUpdateStrategy updateStrategy = 7;
      Specified by:
      getUpdateStrategyOrBuilder in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasRevisionHistoryLimit

      public boolean hasRevisionHistoryLimit()
       revisionHistoryLimit is the maximum number of revisions that will
 be maintained in the StatefulSet's revision history. The revision history
 consists of all revisions not represented by a currently applied
 StatefulSetSpec version. The default value is 10.
      optional int32 revisionHistoryLimit = 8;
      Specified by:
      hasRevisionHistoryLimit in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getRevisionHistoryLimit

      public int getRevisionHistoryLimit()
       revisionHistoryLimit is the maximum number of revisions that will
 be maintained in the StatefulSet's revision history. The revision history
 consists of all revisions not represented by a currently applied
 StatefulSetSpec version. The default value is 10.
      optional int32 revisionHistoryLimit = 8;
      Specified by:
      getRevisionHistoryLimit in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • hasMinReadySeconds

      public boolean hasMinReadySeconds()
       Minimum number of seconds for which a newly created pod should be ready
 without any of its container crashing for it to be considered available.
 Defaults to 0 (pod will be considered available as soon as it is ready)
 This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.
 +optional
      optional int32 minReadySeconds = 9;
      Specified by:
      hasMinReadySeconds in interface V1beta1Apps.StatefulSetSpecOrBuilder

    • getMinReadySeconds

      public int getMinReadySeconds()
       Minimum number of seconds for which a newly created pod should be ready
 without any of its container crashing for it to be considered available.
 Defaults to 0 (pod will be considered available as soon as it is ready)
 This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.
 +optional
      optional int32 minReadySeconds = 9;
      Specified by:
      getMinReadySeconds in interface V1beta1Apps.StatefulSetSpecOrBuilder

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

    • parseFrom

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

    • parseFrom

      public static V1beta1Apps.StatefulSetSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1beta1Apps.StatefulSetSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static V1beta1Apps.StatefulSetSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static V1beta1Apps.StatefulSetSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static V1beta1Apps.StatefulSetSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static V1beta1Apps.StatefulSetSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static V1beta1Apps.StatefulSetSpec.Builder newBuilder()

    • newBuilder

      public static V1beta1Apps.StatefulSetSpec.Builder newBuilder(V1beta1Apps.StatefulSetSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static V1beta1Apps.StatefulSetSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<V1beta1Apps.StatefulSetSpec> parser()

    • getParserForType

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