Class NodePool.UpgradeSettings.Builder (2.36.0)

Version 2.36.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.1
• 2.3.8

public static final class NodePool.UpgradeSettings.Builder extends GeneratedMessageV3.Builder<NodePool.UpgradeSettings.Builder> implements NodePool.UpgradeSettingsOrBuilder

These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.

maxUnavailable controls the number of nodes that can be simultaneously unavailable.

maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.

(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).

Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.)

Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.

These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool.

If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade.

1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.
2. maxUnavailable controls the number of nodes that can be simultaneously unavailable.

3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).

   If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings.

4. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained.
5. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted.

Protobuf type google.container.v1beta1.NodePool.UpgradeSettings

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > NodePool.UpgradeSettings.Builder

Implements

NodePool.UpgradeSettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NodePool.UpgradeSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public NodePool.UpgradeSettings build()

Returns
Type	Description
NodePool.UpgradeSettings

buildPartial()

public NodePool.UpgradeSettings buildPartial()

Returns
Type	Description
NodePool.UpgradeSettings

clear()

public NodePool.UpgradeSettings.Builder clear()

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBlueGreenSettings()

public NodePool.UpgradeSettings.Builder clearBlueGreenSettings()

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Returns
Type	Description
NodePool.UpgradeSettings.Builder

clearField(Descriptors.FieldDescriptor field)

public NodePool.UpgradeSettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMaxSurge()

public NodePool.UpgradeSettings.Builder clearMaxSurge()

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

int32 max_surge = 1;

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

clearMaxUnavailable()

public NodePool.UpgradeSettings.Builder clearMaxUnavailable()

The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

int32 max_unavailable = 2;

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NodePool.UpgradeSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearStrategy()

public NodePool.UpgradeSettings.Builder clearStrategy()

Update strategy of the node pool.

optional .google.container.v1beta1.NodePoolUpdateStrategy strategy = 3;

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

clone()

public NodePool.UpgradeSettings.Builder clone()

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBlueGreenSettings()

public BlueGreenSettings getBlueGreenSettings()

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Returns
Type	Description
BlueGreenSettings	The blueGreenSettings.

getBlueGreenSettingsBuilder()

public BlueGreenSettings.Builder getBlueGreenSettingsBuilder()

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Returns
Type	Description
BlueGreenSettings.Builder

getBlueGreenSettingsOrBuilder()

public BlueGreenSettingsOrBuilder getBlueGreenSettingsOrBuilder()

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Returns
Type	Description
BlueGreenSettingsOrBuilder

getDefaultInstanceForType()

public NodePool.UpgradeSettings getDefaultInstanceForType()

Returns
Type	Description
NodePool.UpgradeSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMaxSurge()

public int getMaxSurge()

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

int32 max_surge = 1;

Returns
Type	Description
int	The maxSurge.

getMaxUnavailable()

public int getMaxUnavailable()

The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

int32 max_unavailable = 2;

Returns
Type	Description
int	The maxUnavailable.

getStrategy()

public NodePoolUpdateStrategy getStrategy()

Update strategy of the node pool.

optional .google.container.v1beta1.NodePoolUpdateStrategy strategy = 3;

Returns
Type	Description
NodePoolUpdateStrategy	The strategy.

getStrategyValue()

public int getStrategyValue()

Update strategy of the node pool.

optional .google.container.v1beta1.NodePoolUpdateStrategy strategy = 3;

Returns
Type	Description
int	The enum numeric value on the wire for strategy.

hasBlueGreenSettings()

public boolean hasBlueGreenSettings()

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Returns
Type	Description
boolean	Whether the blueGreenSettings field is set.

hasStrategy()

public boolean hasStrategy()

Update strategy of the node pool.

optional .google.container.v1beta1.NodePoolUpdateStrategy strategy = 3;

Returns
Type	Description
boolean	Whether the strategy field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBlueGreenSettings(BlueGreenSettings value)

public NodePool.UpgradeSettings.Builder mergeBlueGreenSettings(BlueGreenSettings value)

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Parameter
Name	Description
value	BlueGreenSettings

Returns
Type	Description
NodePool.UpgradeSettings.Builder

mergeFrom(NodePool.UpgradeSettings other)

public NodePool.UpgradeSettings.Builder mergeFrom(NodePool.UpgradeSettings other)

Parameter
Name	Description
other	NodePool.UpgradeSettings

Returns
Type	Description
NodePool.UpgradeSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NodePool.UpgradeSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public NodePool.UpgradeSettings.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NodePool.UpgradeSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBlueGreenSettings(BlueGreenSettings value)

public NodePool.UpgradeSettings.Builder setBlueGreenSettings(BlueGreenSettings value)

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Parameter
Name	Description
value	BlueGreenSettings

Returns
Type	Description
NodePool.UpgradeSettings.Builder

setBlueGreenSettings(BlueGreenSettings.Builder builderForValue)

public NodePool.UpgradeSettings.Builder setBlueGreenSettings(BlueGreenSettings.Builder builderForValue)

Settings for blue-green upgrade strategy.

optional .google.container.v1beta1.BlueGreenSettings blue_green_settings = 4;

Parameter
Name	Description
builderForValue	BlueGreenSettings.Builder

Returns
Type	Description
NodePool.UpgradeSettings.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public NodePool.UpgradeSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxSurge(int value)

public NodePool.UpgradeSettings.Builder setMaxSurge(int value)

The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.

int32 max_surge = 1;

Parameter
Name	Description
value	int The maxSurge to set.

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

setMaxUnavailable(int value)

public NodePool.UpgradeSettings.Builder setMaxUnavailable(int value)

The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.

int32 max_unavailable = 2;

Parameter
Name	Description
value	int The maxUnavailable to set.

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public NodePool.UpgradeSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStrategy(NodePoolUpdateStrategy value)

public NodePool.UpgradeSettings.Builder setStrategy(NodePoolUpdateStrategy value)

Update strategy of the node pool.

optional .google.container.v1beta1.NodePoolUpdateStrategy strategy = 3;

Parameter
Name	Description
value	NodePoolUpdateStrategy The strategy to set.

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

setStrategyValue(int value)

public NodePool.UpgradeSettings.Builder setStrategyValue(int value)

Update strategy of the node pool.

optional .google.container.v1beta1.NodePoolUpdateStrategy strategy = 3;

Parameter
Name	Description
value	int The enum numeric value on the wire for strategy to set.

Returns
Type	Description
NodePool.UpgradeSettings.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final NodePool.UpgradeSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)