Class UpdateNodePoolRequest (2.5.1)

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
TypeDescription
int

CONFIDENTIAL_NODES_FIELD_NUMBER

public static final int CONFIDENTIAL_NODES_FIELD_NUMBER
Field Value
TypeDescription
int

GCFS_CONFIG_FIELD_NUMBER

public static final int GCFS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

GVNIC_FIELD_NUMBER

public static final int GVNIC_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_TYPE_FIELD_NUMBER

public static final int IMAGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

KUBELET_CONFIG_FIELD_NUMBER

public static final int KUBELET_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LINUX_NODE_CONFIG_FIELD_NUMBER

public static final int LINUX_NODE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATIONS_FIELD_NUMBER

public static final int LOCATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_NETWORK_CONFIG_FIELD_NUMBER

public static final int NODE_NETWORK_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_POOL_ID_FIELD_NUMBER

public static final int NODE_POOL_ID_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_VERSION_FIELD_NUMBER

public static final int NODE_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
TypeDescription
int

TAINTS_FIELD_NUMBER

public static final int TAINTS_FIELD_NUMBER
Field Value
TypeDescription
int

UPGRADE_SETTINGS_FIELD_NUMBER

public static final int UPGRADE_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

WORKLOAD_METADATA_CONFIG_FIELD_NUMBER

public static final int WORKLOAD_METADATA_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateNodePoolRequest getDefaultInstance()
Returns
TypeDescription
UpdateNodePoolRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateNodePoolRequest prototype)

public static UpdateNodePoolRequest.Builder newBuilder(UpdateNodePoolRequest prototype)
Parameter
NameDescription
prototypeUpdateNodePoolRequest
Returns
TypeDescription
UpdateNodePoolRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getClusterId() (deprecated)

public String getClusterId()

Deprecated. google.container.v1.UpdateNodePoolRequest.cluster_id is deprecated. See google/container/v1/cluster_service.proto;l=2134

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
TypeDescription
String

The clusterId.

getClusterIdBytes() (deprecated)

public ByteString getClusterIdBytes()

Deprecated. google.container.v1.UpdateNodePoolRequest.cluster_id is deprecated. See google/container/v1/cluster_service.proto;l=2134

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
TypeDescription
ByteString

The bytes for clusterId.

getConfidentialNodes()

public ConfidentialNodes getConfidentialNodes()

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 23;

Returns
TypeDescription
ConfidentialNodes

The confidentialNodes.

getConfidentialNodesOrBuilder()

public ConfidentialNodesOrBuilder getConfidentialNodesOrBuilder()

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 23;

Returns
TypeDescription
ConfidentialNodesOrBuilder

getDefaultInstanceForType()

public UpdateNodePoolRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateNodePoolRequest

getGcfsConfig()

public GcfsConfig getGcfsConfig()

GCFS config.

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

Returns
TypeDescription
GcfsConfig

The gcfsConfig.

getGcfsConfigOrBuilder()

public GcfsConfigOrBuilder getGcfsConfigOrBuilder()

GCFS config.

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

Returns
TypeDescription
GcfsConfigOrBuilder

getGvnic()

public VirtualNIC getGvnic()

Enable or disable gvnic on the node pool.

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

Returns
TypeDescription
VirtualNIC

The gvnic.

getGvnicOrBuilder()

public VirtualNICOrBuilder getGvnicOrBuilder()

Enable or disable gvnic on the node pool.

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

Returns
TypeDescription
VirtualNICOrBuilder

getImageType()

public String getImageType()

Required. The desired image type for the node pool.

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

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for imageType.

getKubeletConfig()

public NodeKubeletConfig getKubeletConfig()

Node kubelet configs.

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

Returns
TypeDescription
NodeKubeletConfig

The kubeletConfig.

getKubeletConfigOrBuilder()

public NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()

Node kubelet configs.

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

Returns
TypeDescription
NodeKubeletConfigOrBuilder

getLabels()

public NodeLabels getLabels()

The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.

.google.container.v1.NodeLabels labels = 18;

Returns
TypeDescription
NodeLabels

The labels.

getLabelsOrBuilder()

public NodeLabelsOrBuilder getLabelsOrBuilder()

The desired node labels to be applied to all nodes in the node pool. If this field is not present, the labels will not be changed. Otherwise, the existing node labels will be replaced with the provided labels.

.google.container.v1.NodeLabels labels = 18;

Returns
TypeDescription
NodeLabelsOrBuilder

getLinuxNodeConfig()

public LinuxNodeConfig getLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

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

Returns
TypeDescription
LinuxNodeConfig

The linuxNodeConfig.

getLinuxNodeConfigOrBuilder()

public LinuxNodeConfigOrBuilder getLinuxNodeConfigOrBuilder()

Parameters that can be configured on Linux nodes.

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

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getNodeNetworkConfig()

public NodeNetworkConfig getNodeNetworkConfig()

Node network config.

.google.container.v1.NodeNetworkConfig node_network_config = 21;

Returns
TypeDescription
NodeNetworkConfig

The nodeNetworkConfig.

getNodeNetworkConfigOrBuilder()

public NodeNetworkConfigOrBuilder getNodeNetworkConfigOrBuilder()

Node network config.

.google.container.v1.NodeNetworkConfig node_network_config = 21;

Returns
TypeDescription
NodeNetworkConfigOrBuilder

getNodePoolId() (deprecated)

public String getNodePoolId()

Deprecated. google.container.v1.UpdateNodePoolRequest.node_pool_id is deprecated. See google/container/v1/cluster_service.proto;l=2138

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
TypeDescription
String

The nodePoolId.

getNodePoolIdBytes() (deprecated)

public ByteString getNodePoolIdBytes()

Deprecated. google.container.v1.UpdateNodePoolRequest.node_pool_id is deprecated. See google/container/v1/cluster_service.proto;l=2138

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for nodeVersion.

getParserForType()

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

getProjectId() (deprecated)

public String getProjectId()

Deprecated. google.container.v1.UpdateNodePoolRequest.project_id is deprecated. See google/container/v1/cluster_service.proto;l=2124

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
TypeDescription
String

The projectId.

getProjectIdBytes() (deprecated)

public ByteString getProjectIdBytes()

Deprecated. google.container.v1.UpdateNodePoolRequest.project_id is deprecated. See google/container/v1/cluster_service.proto;l=2124

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
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTags()

public NetworkTags getTags()

The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.

.google.container.v1.NetworkTags tags = 16;

Returns
TypeDescription
NetworkTags

The tags.

getTagsOrBuilder()

public NetworkTagsOrBuilder getTagsOrBuilder()

The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be replaced with the provided tags.

.google.container.v1.NetworkTags tags = 16;

Returns
TypeDescription
NetworkTagsOrBuilder

getTaints()

public NodeTaints getTaints()

The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.

.google.container.v1.NodeTaints taints = 17;

Returns
TypeDescription
NodeTaints

The taints.

getTaintsOrBuilder()

public NodeTaintsOrBuilder getTaintsOrBuilder()

The desired node taints to be applied to all nodes in the node pool. If this field is not present, the taints will not be changed. Otherwise, the existing node taints will be replaced with the provided taints.

.google.container.v1.NodeTaints taints = 17;

Returns
TypeDescription
NodeTaintsOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
NodePool.UpgradeSettingsOrBuilder

getWorkloadMetadataConfig()

public WorkloadMetadataConfig getWorkloadMetadataConfig()

The desired workload metadata config for the node pool.

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

Returns
TypeDescription
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
TypeDescription
WorkloadMetadataConfigOrBuilder

getZone() (deprecated)

public String getZone()

Deprecated. google.container.v1.UpdateNodePoolRequest.zone is deprecated. See google/container/v1/cluster_service.proto;l=2130

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
TypeDescription
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

Deprecated. google.container.v1.UpdateNodePoolRequest.zone is deprecated. See google/container/v1/cluster_service.proto;l=2130

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
TypeDescription
ByteString

The bytes for zone.

hasConfidentialNodes()

public boolean hasConfidentialNodes()

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 23;

Returns
TypeDescription
boolean

Whether the confidentialNodes field is set.

hasGcfsConfig()

public boolean hasGcfsConfig()

GCFS config.

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

Returns
TypeDescription
boolean

Whether the gcfsConfig field is set.

hasGvnic()

public boolean hasGvnic()

Enable or disable gvnic on t