Class UpdateSettings.Builder (0.44.0)

public static final class UpdateSettings.Builder extends GeneratedMessageV3.Builder<UpdateSettings.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateSettings.Builder
Overrides

build()

public UpdateSettings build()
Returns
Type Description
UpdateSettings

buildPartial()

public UpdateSettings buildPartial()
Returns
Type Description
UpdateSettings

clear()

public UpdateSettings.Builder clear()
Returns
Type Description
UpdateSettings.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateSettings.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateSettings.Builder
Overrides

clearSurgeSettings()

public UpdateSettings.Builder clearSurgeSettings()

Optional. Settings for surge update.

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

Returns
Type Description
UpdateSettings.Builder

clone()

public UpdateSettings.Builder clone()
Returns
Type Description
UpdateSettings.Builder
Overrides

getDefaultInstanceForType()

public UpdateSettings getDefaultInstanceForType()
Returns
Type Description
UpdateSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getSurgeSettings()

public SurgeSettings getSurgeSettings()

Optional. Settings for surge update.

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

Returns
Type Description
SurgeSettings

The surgeSettings.

getSurgeSettingsBuilder()

public SurgeSettings.Builder getSurgeSettingsBuilder()

Optional. Settings for surge update.

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

Returns
Type Description
SurgeSettings.Builder

getSurgeSettingsOrBuilder()

public SurgeSettingsOrBuilder getSurgeSettingsOrBuilder()

Optional. Settings for surge update.

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

Returns
Type Description
SurgeSettingsOrBuilder

hasSurgeSettings()

public boolean hasSurgeSettings()

Optional. Settings for surge update.

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

Returns
Type Description
boolean

Whether the surgeSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateSettings other)

public UpdateSettings.Builder mergeFrom(UpdateSettings other)
Parameter
Name Description
other UpdateSettings
Returns
Type Description
UpdateSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateSettings.Builder
Overrides

mergeSurgeSettings(SurgeSettings value)

public UpdateSettings.Builder mergeSurgeSettings(SurgeSettings value)

Optional. Settings for surge update.

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

Parameter
Name Description
value SurgeSettings
Returns
Type Description
UpdateSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateSettings.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateSettings.Builder
Overrides

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

public UpdateSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateSettings.Builder
Overrides

setSurgeSettings(SurgeSettings value)

public UpdateSettings.Builder setSurgeSettings(SurgeSettings value)

Optional. Settings for surge update.

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

Parameter
Name Description
value SurgeSettings
Returns
Type Description
UpdateSettings.Builder

setSurgeSettings(SurgeSettings.Builder builderForValue)

public UpdateSettings.Builder setSurgeSettings(SurgeSettings.Builder builderForValue)

Optional. Settings for surge update.

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

Parameter
Name Description
builderForValue SurgeSettings.Builder
Returns
Type Description
UpdateSettings.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateSettings.Builder
Overrides