Class NodePool.UpgradeSettings (2.7.0)

Version 2.7.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 extends GeneratedMessageV3 implements NodePool.UpgradeSettingsOrBuilder

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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NodePool.UpgradeSettings

Implements

NodePool.UpgradeSettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BLUE_GREEN_SETTINGS_FIELD_NUMBER

public static final int BLUE_GREEN_SETTINGS_FIELD_NUMBER

Field Value

Type	Description
int

MAX_SURGE_FIELD_NUMBER

public static final int MAX_SURGE_FIELD_NUMBER

Field Value

Type	Description
int

MAX_UNAVAILABLE_FIELD_NUMBER

public static final int MAX_UNAVAILABLE_FIELD_NUMBER

Field Value

Type	Description
int

STRATEGY_FIELD_NUMBER

public static final int STRATEGY_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static NodePool.UpgradeSettings getDefaultInstance()

Returns

Type	Description
NodePool.UpgradeSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static NodePool.UpgradeSettings.Builder newBuilder()

Returns

Type	Description
NodePool.UpgradeSettings.Builder

newBuilder(NodePool.UpgradeSettings prototype)

public static NodePool.UpgradeSettings.Builder newBuilder(NodePool.UpgradeSettings prototype)

Parameter

Name	Description
prototype	NodePool.UpgradeSettings

Returns

Type	Description
NodePool.UpgradeSettings.Builder

parseDelimitedFrom(InputStream input)

public static NodePool.UpgradeSettings parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static NodePool.UpgradeSettings parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NodePool.UpgradeSettings parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NodePool.UpgradeSettings parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static NodePool.UpgradeSettings parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static NodePool.UpgradeSettings parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NodePool.UpgradeSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
NodePool.UpgradeSettings

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<NodePool.UpgradeSettings> parser()

Returns

Type	Description
Parser<UpgradeSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.

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

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.

getParserForType()

public Parser<NodePool.UpgradeSettings> getParserForType()

Returns

Type	Description
Parser<UpgradeSettings>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public NodePool.UpgradeSettings.Builder newBuilderForType()

Returns

Type	Description
NodePool.UpgradeSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NodePool.UpgradeSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
NodePool.UpgradeSettings.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public NodePool.UpgradeSettings.Builder toBuilder()

Returns

Type	Description
NodePool.UpgradeSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException