Class UpdateNodePoolRequest (2.3.8)

public final class UpdateNodePoolRequest extends GeneratedMessageV3 implements UpdateNodePoolRequestOrBuilder

UpdateNodePoolRequests update a node pool's image and/or version.

Protobuf type google.container.v1.UpdateNodePoolRequest

Static Fields

CLUSTER_ID_FIELD_NUMBER

public static final int CLUSTER_ID_FIELD_NUMBER
Field Value
Type Description
int

GCFS_CONFIG_FIELD_NUMBER

public static final int GCFS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

GVNIC_FIELD_NUMBER

public static final int GVNIC_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_TYPE_FIELD_NUMBER

public static final int IMAGE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

KUBELET_CONFIG_FIELD_NUMBER

public static final int KUBELET_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LINUX_NODE_CONFIG_FIELD_NUMBER

public static final int LINUX_NODE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LOCATIONS_FIELD_NUMBER

public static final int LOCATIONS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NODE_POOL_ID_FIELD_NUMBER

public static final int NODE_POOL_ID_FIELD_NUMBER
Field Value
Type Description
int

NODE_VERSION_FIELD_NUMBER

public static final int NODE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

UPGRADE_SETTINGS_FIELD_NUMBER

public static final int UPGRADE_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_METADATA_CONFIG_FIELD_NUMBER

public static final int WORKLOAD_METADATA_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateNodePoolRequest getDefaultInstance()
Returns
Type Description
UpdateNodePoolRequest

getDescriptor()

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

newBuilder()

public static UpdateNodePoolRequest.Builder newBuilder()
Returns
Type Description
UpdateNodePoolRequest.Builder

newBuilder(UpdateNodePoolRequest prototype)

public static UpdateNodePoolRequest.Builder newBuilder(UpdateNodePoolRequest prototype)
Parameter
Name Description
prototype UpdateNodePoolRequest
Returns
Type Description
UpdateNodePoolRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateNodePoolRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateNodePoolRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateNodePoolRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateNodePoolRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateNodePoolRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateNodePoolRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateNodePoolRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateNodePoolRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateNodePoolRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateNodePoolRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateNodePoolRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateNodePoolRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateNodePoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateNodePoolRequest> parser()
Returns
Type Description
Parser<UpdateNodePoolRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getClusterId() (deprecated)

public String getClusterId()

Deprecated.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

string cluster_id = 3 [deprecated = true];

Returns
Type Description
String

The clusterId.

getClusterIdBytes() (deprecated)

public ByteString getClusterIdBytes()

Deprecated.

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.

string cluster_id = 3 [deprecated = true];

Returns
Type Description
ByteString

The bytes for clusterId.

getDefaultInstanceForType()

public UpdateNodePoolRequest getDefaultInstanceForType()
Returns
Type Description
UpdateNodePoolRequest

getGcfsConfig()

public GcfsConfig getGcfsConfig()

GCFS config.

.google.container.v1.GcfsConfig gcfs_config = 22;

Returns
Type Description
GcfsConfig

The gcfsConfig.

getGcfsConfigOrBuilder()

public GcfsConfigOrBuilder getGcfsConfigOrBuilder()

GCFS config.

.google.container.v1.GcfsConfig gcfs_config = 22;

Returns
Type Description
GcfsConfigOrBuilder

getGvnic()

public VirtualNIC getGvnic()

Enable or disable gvnic on the node pool.

.google.container.v1.VirtualNIC gvnic = 29;

Returns
Type Description
VirtualNIC

The gvnic.

getGvnicOrBuilder()

public VirtualNICOrBuilder getGvnicOrBuilder()

Enable or disable gvnic on the node pool.

.google.container.v1.VirtualNIC gvnic = 29;

Returns
Type Description
VirtualNICOrBuilder

getImageType()

public String getImageType()

Required. The desired image type for the node pool.

string image_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The imageType.

getImageTypeBytes()

public ByteString getImageTypeBytes()

Required. The desired image type for the node pool.

string image_type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for imageType.

getKubeletConfig()

public NodeKubeletConfig getKubeletConfig()

Node kubelet configs.

.google.container.v1.NodeKubeletConfig kubelet_config = 20;

Returns
Type Description
NodeKubeletConfig

The kubeletConfig.

getKubeletConfigOrBuilder()

public NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()

Node kubelet configs.

.google.container.v1.NodeKubeletConfig kubelet_config = 20;

Returns
Type Description
NodeKubeletConfigOrBuilder

getLinuxNodeConfig()

public LinuxNodeConfig getLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

.google.container.v1.LinuxNodeConfig linux_node_config = 19;

Returns
Type Description
LinuxNodeConfig

The linuxNodeConfig.

getLinuxNodeConfigOrBuilder()

public LinuxNodeConfigOrBuilder getLinuxNodeConfigOrBuilder()

Parameters that can be configured on Linux nodes.

.google.container.v1.LinuxNodeConfig linux_node_config = 19;

Returns
Type Description
LinuxNodeConfigOrBuilder

getLocations(int index)

public String getLocations(int index)

The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.

repeated string locations = 13;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The locations at the given index.

getLocationsBytes(int index)

public ByteString getLocationsBytes(int index)

The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.

repeated string locations = 13;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the locations at the given index.

getLocationsCount()

public int getLocationsCount()

The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.

repeated string locations = 13;

Returns
Type Description
int

The count of locations.

getLocationsList()

public ProtocolStringList getLocationsList()

The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.

repeated string locations = 13;

Returns
Type Description
ProtocolStringList

A list containing the locations.

getName()

public String getName()

The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

string name = 8;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

string name = 8;

Returns
Type Description
ByteString

The bytes for name.

getNodePoolId() (deprecated)

public String getNodePoolId()

Deprecated.

Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

string node_pool_id = 4 [deprecated = true];

Returns
Type Description
String

The nodePoolId.

getNodePoolIdBytes() (deprecated)

public ByteString getNodePoolIdBytes()

Deprecated.

Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.

string node_pool_id = 4 [deprecated = true];

Returns
Type Description
ByteString

The bytes for nodePoolId.

getNodeVersion()

public String getNodeVersion()

Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the Kubernetes master version

string node_version = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The nodeVersion.

getNodeVersionBytes()

public ByteString getNodeVersionBytes()

Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "-": picks the Kubernetes master version

string node_version = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for nodeVersion.

getParserForType()

public Parser<UpdateNodePoolRequest> getParserForType()
Returns
Type Description
Parser<UpdateNodePoolRequest>
Overrides

getProjectId() (deprecated)

public String getProjectId()

Deprecated.

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

string project_id = 1 [deprecated = true];

Returns
Type Description
String

The projectId.

getProjectIdBytes() (deprecated)

public ByteString getProjectIdBytes()

Deprecated.

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

string project_id = 1 [deprecated = true];

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpgradeSettings()

public NodePool.UpgradeSettings getUpgradeSettings()

Upgrade settings control disruption and speed of the upgrade.

.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;

Returns
Type Description
NodePool.UpgradeSettings

The upgradeSettings.

getUpgradeSettingsOrBuilder()

public NodePool.UpgradeSettingsOrBuilder getUpgradeSettingsOrBuilder()

Upgrade settings control disruption and speed of the upgrade.

.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;

Returns
Type Description
NodePool.UpgradeSettingsOrBuilder

getWorkloadMetadataConfig()

public WorkloadMetadataConfig getWorkloadMetadataConfig()

The desired workload metadata config for the node pool.

.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;

Returns
Type Description
WorkloadMetadataConfig

The workloadMetadataConfig.

getWorkloadMetadataConfigOrBuilder()

public WorkloadMetadataConfigOrBuilder getWorkloadMetadataConfigOrBuilder()

The desired workload metadata config for the node pool.

.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;

Returns
Type Description
WorkloadMetadataConfigOrBuilder

getZone() (deprecated)

public String getZone()

Deprecated.

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

string zone = 2 [deprecated = true];

Returns
Type Description
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

Deprecated.

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

string zone = 2 [deprecated = true];

Returns
Type Description
ByteString

The bytes for zone.

hasGcfsConfig()

public boolean hasGcfsConfig()

GCFS config.

.google.container.v1.GcfsConfig gcfs_config = 22;

Returns
Type Description
boolean

Whether the gcfsConfig field is set.

hasGvnic()

public boolean hasGvnic()

Enable or disable gvnic on the node pool.

.google.container.v1.VirtualNIC gvnic = 29;

Returns
Type Description
boolean

Whether the gvnic field is set.

hasKubeletConfig()

public boolean hasKubeletConfig()

Node kubelet configs.

.google.container.v1.NodeKubeletConfig kubelet_config = 20;

Returns
Type Description
boolean

Whether the kubeletConfig field is set.

hasLinuxNodeConfig()

public boolean hasLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

.google.container.v1.LinuxNodeConfig linux_node_config = 19;

Returns
Type Description
boolean

Whether the linuxNodeConfig field is set.

hasUpgradeSettings()

public boolean hasUpgradeSettings()

Upgrade settings control disruption and speed of the upgrade.

.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;

Returns
Type Description
boolean

Whether the upgradeSettings field is set.

hasWorkloadMetadataConfig()

public boolean hasWorkloadMetadataConfig()

The desired workload metadata config for the node pool.

.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;

Returns
Type Description
boolean

Whether the workloadMetadataConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateNodePoolRequest.Builder newBuilderForType()
Returns
Type Description
UpdateNodePoolRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateNodePoolRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateNodePoolRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateNodePoolRequest.Builder toBuilder()
Returns
Type Description
UpdateNodePoolRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException