Class UpdateSettings (0.34.0)

public final class UpdateSettings extends GeneratedMessageV3 implements UpdateSettingsOrBuilder

UpdateSettings control the level of parallelism and the level of disruption caused during the update of a node pool.

These settings are applicable when the node pool update requires replacing the existing node pool nodes with the updated ones.

UpdateSettings are optional. When UpdateSettings are not specified during the node pool creation, a default is chosen based on the parent cluster's version. For clusters with minor version 1.27 and later, a default surge_settings configuration with max_surge = 1 and max_unavailable = 0 is used. For clusters with older versions, node pool updates use the traditional rolling update mechanism of updating one node at a time in a "terminate before create" fashion and update_settings is not applicable.

Set the surge_settings parameter to use the Surge Update mechanism for the rolling update of node pool nodes.

  1. max_surge controls the number of additional nodes that can be created beyond the current size of the node pool temporarily for the time of the update to increase the number of available nodes.
  2. max_unavailable controls the number of nodes that can be simultaneously unavailable during the update.
  3. (max_surge + max_unavailable) determines the level of parallelism (i.e., the number of nodes being updated at the same time).

Protobuf type google.cloud.gkemulticloud.v1.UpdateSettings

Static Fields

SURGE_SETTINGS_FIELD_NUMBER

public static final int SURGE_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateSettings getDefaultInstance()
Returns
TypeDescription
UpdateSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UpdateSettings.Builder newBuilder()
Returns
TypeDescription
UpdateSettings.Builder

newBuilder(UpdateSettings prototype)

public static UpdateSettings.Builder newBuilder(UpdateSettings prototype)
Parameter
NameDescription
prototypeUpdateSettings
Returns
TypeDescription
UpdateSettings.Builder

parseDelimitedFrom(InputStream input)

public static UpdateSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateSettings> parser()
Returns
TypeDescription
Parser<UpdateSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UpdateSettings getDefaultInstanceForType()
Returns
TypeDescription
UpdateSettings

getParserForType()

public Parser<UpdateSettings> getParserForType()
Returns
TypeDescription
Parser<UpdateSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSurgeSettings()

public SurgeSettings getSurgeSettings()

Optional. Settings for surge update.

.google.cloud.gkemulticloud.v1.SurgeSettings surge_settings = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SurgeSettings

The surgeSettings.

getSurgeSettingsOrBuilder()

public SurgeSettingsOrBuilder getSurgeSettingsOrBuilder()

Optional. Settings for surge update.

.google.cloud.gkemulticloud.v1.SurgeSettings surge_settings = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
SurgeSettingsOrBuilder

hasSurgeSettings()

public boolean hasSurgeSettings()

Optional. Settings for surge update.

.google.cloud.gkemulticloud.v1.SurgeSettings surge_settings = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the surgeSettings field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateSettings.Builder newBuilderForType()
Returns
TypeDescription
UpdateSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateSettings.Builder toBuilder()
Returns
TypeDescription
UpdateSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException