Interface UpdateNodePoolRequestOrBuilder (2.37.0)

Version 2.37.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 interface UpdateNodePoolRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClusterId() (deprecated)

public abstract String getClusterId()

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

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 abstract ByteString getClusterIdBytes()

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

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.

getConfidentialNodes()

public abstract 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
Type	Description
ConfidentialNodes	The confidentialNodes.

getConfidentialNodesOrBuilder()

public abstract 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
Type	Description
ConfidentialNodesOrBuilder

getDiskSizeGb()

public abstract long getDiskSizeGb()

Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.

int64 disk_size_gb = 38 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
long	The diskSizeGb.

getDiskType()

public abstract String getDiskType()

Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.

string disk_type = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The diskType.

getDiskTypeBytes()

public abstract ByteString getDiskTypeBytes()

Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.

string disk_type = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for diskType.

getEtag()

public abstract String getEtag()

The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.

string etag = 30;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.

string etag = 30;

Returns
Type	Description
ByteString	The bytes for etag.

getFastSocket()

public abstract FastSocket getFastSocket()

Enable or disable NCCL fast socket for the node pool.

.google.container.v1.FastSocket fast_socket = 31;

Returns
Type	Description
FastSocket	The fastSocket.

getFastSocketOrBuilder()

public abstract FastSocketOrBuilder getFastSocketOrBuilder()

Enable or disable NCCL fast socket for the node pool.

.google.container.v1.FastSocket fast_socket = 31;

Returns
Type	Description
FastSocketOrBuilder

getGcfsConfig()

public abstract GcfsConfig getGcfsConfig()

GCFS config.

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

Returns
Type	Description
GcfsConfig	The gcfsConfig.

getGcfsConfigOrBuilder()

public abstract GcfsConfigOrBuilder getGcfsConfigOrBuilder()

GCFS config.

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

Returns
Type	Description
GcfsConfigOrBuilder

getGvnic()

public abstract VirtualNIC getGvnic()

Enable or disable gvnic on the node pool.

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

Returns
Type	Description
VirtualNIC	The gvnic.

getGvnicOrBuilder()

public abstract VirtualNICOrBuilder getGvnicOrBuilder()

Enable or disable gvnic on the node pool.

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

Returns
Type	Description
VirtualNICOrBuilder

getImageType()

public abstract String getImageType()

Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

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

Returns
Type	Description
String	The imageType.

getImageTypeBytes()

public abstract ByteString getImageTypeBytes()

Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

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

Returns
Type	Description
ByteString	The bytes for imageType.

getKubeletConfig()

public abstract NodeKubeletConfig getKubeletConfig()

Node kubelet configs.

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

Returns
Type	Description
NodeKubeletConfig	The kubeletConfig.

getKubeletConfigOrBuilder()

public abstract NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()

Node kubelet configs.

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

Returns
Type	Description
NodeKubeletConfigOrBuilder

getLabels()

public abstract 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
Type	Description
NodeLabels	The labels.

getLabelsOrBuilder()

public abstract 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
Type	Description
NodeLabelsOrBuilder

getLinuxNodeConfig()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the locations.

getLoggingConfig()

public abstract NodePoolLoggingConfig getLoggingConfig()

Logging configuration.

.google.container.v1.NodePoolLoggingConfig logging_config = 32;

Returns
Type	Description
NodePoolLoggingConfig	The loggingConfig.

getLoggingConfigOrBuilder()

public abstract NodePoolLoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration.

.google.container.v1.NodePoolLoggingConfig logging_config = 32;

Returns
Type	Description
NodePoolLoggingConfigOrBuilder

getMachineType()

public abstract String getMachineType()

Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.

string machine_type = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The machineType.

getMachineTypeBytes()

public abstract ByteString getMachineTypeBytes()

Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.

string machine_type = 36 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for machineType.

getName()

public abstract 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 abstract 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.

getNodeNetworkConfig()

public abstract NodeNetworkConfig getNodeNetworkConfig()

Node network config.

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

Returns
Type	Description
NodeNetworkConfig	The nodeNetworkConfig.

getNodeNetworkConfigOrBuilder()

public abstract NodeNetworkConfigOrBuilder getNodeNetworkConfigOrBuilder()

Node network config.

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

Returns
Type	Description
NodeNetworkConfigOrBuilder

getNodePoolId() (deprecated)

public abstract String getNodePoolId()

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

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 abstract ByteString getNodePoolIdBytes()

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

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 abstract 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 abstract 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.

getProjectId() (deprecated)

public abstract String getProjectId()

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

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 abstract ByteString getProjectIdBytes()

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

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.

getResourceLabels()

public abstract ResourceLabels getResourceLabels()

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

.google.container.v1.ResourceLabels resource_labels = 33;

Returns
Type	Description
ResourceLabels	The resourceLabels.

getResourceLabelsOrBuilder()

public abstract ResourceLabelsOrBuilder getResourceLabelsOrBuilder()

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

.google.container.v1.ResourceLabels resource_labels = 33;

Returns
Type	Description
ResourceLabelsOrBuilder

getResourceManagerTags()

public abstract ResourceManagerTags getResourceManagerTags()

Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.

.google.container.v1.ResourceManagerTags resource_manager_tags = 39;

Returns
Type	Description
ResourceManagerTags	The resourceManagerTags.

getResourceManagerTagsOrBuilder()

public abstract ResourceManagerTagsOrBuilder getResourceManagerTagsOrBuilder()

Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.

.google.container.v1.ResourceManagerTags resource_manager_tags = 39;

Returns
Type	Description
ResourceManagerTagsOrBuilder

getTags()

public abstract 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
Type	Description
NetworkTags	The tags.

getTagsOrBuilder()

public abstract 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
Type	Description
NetworkTagsOrBuilder

getTaints()

public abstract 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
Type	Description
NodeTaints	The taints.

getTaintsOrBuilder()

public abstract 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
Type	Description
NodeTaintsOrBuilder

getUpgradeSettings()

public abstract 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 abstract 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

getWindowsNodeConfig()

public abstract WindowsNodeConfig getWindowsNodeConfig()

Parameters that can be configured on Windows nodes.

.google.container.v1.WindowsNodeConfig windows_node_config = 34;

Returns
Type	Description
WindowsNodeConfig	The windowsNodeConfig.

getWindowsNodeConfigOrBuilder()

public abstract WindowsNodeConfigOrBuilder getWindowsNodeConfigOrBuilder()

Parameters that can be configured on Windows nodes.

.google.container.v1.WindowsNodeConfig windows_node_config = 34;

Returns
Type	Description
WindowsNodeConfigOrBuilder

getWorkloadMetadataConfig()

public abstract 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 abstract 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 abstract String getZone()

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

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 abstract ByteString getZoneBytes()

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

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.

hasConfidentialNodes()

public abstract 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
Type	Description
boolean	Whether the confidentialNodes field is set.

hasFastSocket()

public abstract boolean hasFastSocket()

Enable or disable NCCL fast socket for the node pool.

.google.container.v1.FastSocket fast_socket = 31;

Returns
Type	Description
boolean	Whether the fastSocket field is set.

hasGcfsConfig()

public abstract boolean hasGcfsConfig()

GCFS config.

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

Returns
Type	Description
boolean	Whether the gcfsConfig field is set.

hasGvnic()

public abstract 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 abstract boolean hasKubeletConfig()

Node kubelet configs.

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

Returns
Type	Description
boolean	Whether the kubeletConfig field is set.

hasLabels()

public abstract boolean hasLabels()

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
Type	Description
boolean	Whether the labels field is set.

hasLinuxNodeConfig()

public abstract 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.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Logging configuration.

.google.container.v1.NodePoolLoggingConfig logging_config = 32;

Returns
Type	Description
boolean	Whether the loggingConfig field is set.

hasNodeNetworkConfig()

public abstract boolean hasNodeNetworkConfig()

Node network config.

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

Returns
Type	Description
boolean	Whether the nodeNetworkConfig field is set.

hasResourceLabels()

public abstract boolean hasResourceLabels()

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

.google.container.v1.ResourceLabels resource_labels = 33;

Returns
Type	Description
boolean	Whether the resourceLabels field is set.

hasResourceManagerTags()

public abstract boolean hasResourceManagerTags()

Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.

.google.container.v1.ResourceManagerTags resource_manager_tags = 39;

Returns
Type	Description
boolean	Whether the resourceManagerTags field is set.

hasTags()

public abstract boolean hasTags()

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
Type	Description
boolean	Whether the tags field is set.

hasTaints()

public abstract boolean hasTaints()

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
Type	Description
boolean	Whether the taints field is set.

hasUpgradeSettings()

public abstract 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.

hasWindowsNodeConfig()

public abstract boolean hasWindowsNodeConfig()

Parameters that can be configured on Windows nodes.

.google.container.v1.WindowsNodeConfig windows_node_config = 34;

Returns
Type	Description
boolean	Whether the windowsNodeConfig field is set.

hasWorkloadMetadataConfig()

public abstract 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.