io.kubernetes.client.proto

Interface V1Apps.StatefulSetSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

V1Apps.StatefulSetSpec, V1Apps.StatefulSetSpec.Builder

Enclosing class:

V1Apps

public static interface V1Apps.StatefulSetSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getPodManagementPolicy() podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
com.google.protobuf.ByteString	getPodManagementPolicyBytes() podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
int	getReplicas() replicas is the desired number of replicas of the given Template.
int	getRevisionHistoryLimit() revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history.
Meta.LabelSelector	getSelector() selector is a label query over pods that should match the replica count.
Meta.LabelSelectorOrBuilder	getSelectorOrBuilder() selector is a label query over pods that should match the replica count.
String	getServiceName() serviceName is the name of the service that governs this StatefulSet.
com.google.protobuf.ByteString	getServiceNameBytes() serviceName is the name of the service that governs this StatefulSet.
V1.PodTemplateSpec	getTemplate() template is the object that describes the pod that will be created if insufficient replicas are detected.
V1.PodTemplateSpecOrBuilder	getTemplateOrBuilder() template is the object that describes the pod that will be created if insufficient replicas are detected.
V1Apps.StatefulSetUpdateStrategy	getUpdateStrategy() updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
V1Apps.StatefulSetUpdateStrategyOrBuilder	getUpdateStrategyOrBuilder() updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
V1.PersistentVolumeClaim	getVolumeClaimTemplates(int index) volumeClaimTemplates is a list of claims that pods are allowed to reference.
int	getVolumeClaimTemplatesCount() volumeClaimTemplates is a list of claims that pods are allowed to reference.
List<V1.PersistentVolumeClaim>	getVolumeClaimTemplatesList() volumeClaimTemplates is a list of claims that pods are allowed to reference.
V1.PersistentVolumeClaimOrBuilder	getVolumeClaimTemplatesOrBuilder(int index) volumeClaimTemplates is a list of claims that pods are allowed to reference.
List<? extends V1.PersistentVolumeClaimOrBuilder>	getVolumeClaimTemplatesOrBuilderList() volumeClaimTemplates is a list of claims that pods are allowed to reference.
boolean	hasPodManagementPolicy() podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
boolean	hasReplicas() replicas is the desired number of replicas of the given Template.
boolean	hasRevisionHistoryLimit() revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history.
boolean	hasSelector() selector is a label query over pods that should match the replica count.
boolean	hasServiceName() serviceName is the name of the service that governs this StatefulSet.
boolean	hasTemplate() template is the object that describes the pod that will be created if insufficient replicas are detected.
boolean	hasUpdateStrategy() updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasReplicas

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;

getReplicas

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;

hasSelector

boolean hasSelector()

 selector is a label query over pods that should match the replica count.
 It must match the pod template's labels.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;

getSelector

Meta.LabelSelector getSelector()

 selector is a label query over pods that should match the replica count.
 It must match the pod template's labels.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;

getSelectorOrBuilder

Meta.LabelSelectorOrBuilder getSelectorOrBuilder()

 selector is a label query over pods that should match the replica count.
 It must match the pod template's labels.
 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 

optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;

hasTemplate

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;

getTemplate

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;

getTemplateOrBuilder

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;

getVolumeClaimTemplatesList

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;

getVolumeClaimTemplates

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;

getVolumeClaimTemplatesCount

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;

getVolumeClaimTemplatesOrBuilderList

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;

getVolumeClaimTemplatesOrBuilder

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;

hasServiceName

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;

getServiceName

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;

getServiceNameBytes

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;

hasPodManagementPolicy

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;

getPodManagementPolicy

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;

getPodManagementPolicyBytes

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;

hasUpdateStrategy

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.v1.StatefulSetUpdateStrategy updateStrategy = 7;

getUpdateStrategy

V1Apps.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.v1.StatefulSetUpdateStrategy updateStrategy = 7;

getUpdateStrategyOrBuilder

V1Apps.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.v1.StatefulSetUpdateStrategy updateStrategy = 7;

hasRevisionHistoryLimit

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;

getRevisionHistoryLimit

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;