UpdateNodePoolRequest (Kubernetes Engine API v1-rev20230519-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.container.model.UpdateNodePoolRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class UpdateNodePoolRequest
extends com.google.api.client.json.GenericJson
```
UpdateNodePoolRequests update a node pool's image and/or version.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Kubernetes Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

UpdateNodePoolRequest()

Constructors
Constructor and Description
`UpdateNodePoolRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateNodePoolRequest`	`clone()`
`String`	`getClusterId()` Deprecated.
`ConfidentialNodes`	`getConfidentialNodes()` Confidential nodes config.
`String`	`getEtag()` The current etag of the node pool.
`FastSocket`	`getFastSocket()` Enable or disable NCCL fast socket for the node pool.
`GcfsConfig`	`getGcfsConfig()` GCFS config.
`VirtualNIC`	`getGvnic()` Enable or disable gvnic on the node pool.
`String`	`getImageType()` Required.
`NodeKubeletConfig`	`getKubeletConfig()` Node kubelet configs.
`NodeLabels`	`getLabels()` The desired node labels to be applied to all nodes in the node pool.
`LinuxNodeConfig`	`getLinuxNodeConfig()` Parameters that can be configured on Linux nodes.
`List<String>`	`getLocations()` The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located.
`NodePoolLoggingConfig`	`getLoggingConfig()` Logging configuration.
`String`	`getName()` The name (project, location, cluster, node pool) of the node pool to update.
`NodeNetworkConfig`	`getNodeNetworkConfig()` Node network config.
`String`	`getNodePoolId()` Deprecated.
`String`	`getNodeVersion()` Required.
`String`	`getProjectId()` Deprecated.
`ResourceLabels`	`getResourceLabels()` The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
`NetworkTags`	`getTags()` The desired network tags to be applied to all nodes in the node pool.
`NodeTaints`	`getTaints()` The desired node taints to be applied to all nodes in the node pool.
`UpgradeSettings`	`getUpgradeSettings()` Upgrade settings control disruption and speed of the upgrade.
`WindowsNodeConfig`	`getWindowsNodeConfig()` Parameters that can be configured on Windows nodes.
`WorkloadMetadataConfig`	`getWorkloadMetadataConfig()` The desired workload metadata config for the node pool.
`String`	`getZone()` Deprecated.
`UpdateNodePoolRequest`	`set(String fieldName, Object value)`
`UpdateNodePoolRequest`	`setClusterId(String clusterId)` Deprecated.
`UpdateNodePoolRequest`	`setConfidentialNodes(ConfidentialNodes confidentialNodes)` Confidential nodes config.
`UpdateNodePoolRequest`	`setEtag(String etag)` The current etag of the node pool.
`UpdateNodePoolRequest`	`setFastSocket(FastSocket fastSocket)` Enable or disable NCCL fast socket for the node pool.
`UpdateNodePoolRequest`	`setGcfsConfig(GcfsConfig gcfsConfig)` GCFS config.
`UpdateNodePoolRequest`	`setGvnic(VirtualNIC gvnic)` Enable or disable gvnic on the node pool.
`UpdateNodePoolRequest`	`setImageType(String imageType)` Required.
`UpdateNodePoolRequest`	`setKubeletConfig(NodeKubeletConfig kubeletConfig)` Node kubelet configs.
`UpdateNodePoolRequest`	`setLabels(NodeLabels labels)` The desired node labels to be applied to all nodes in the node pool.
`UpdateNodePoolRequest`	`setLinuxNodeConfig(LinuxNodeConfig linuxNodeConfig)` Parameters that can be configured on Linux nodes.
`UpdateNodePoolRequest`	`setLocations(List<String> locations)` The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located.
`UpdateNodePoolRequest`	`setLoggingConfig(NodePoolLoggingConfig loggingConfig)` Logging configuration.
`UpdateNodePoolRequest`	`setName(String name)` The name (project, location, cluster, node pool) of the node pool to update.
`UpdateNodePoolRequest`	`setNodeNetworkConfig(NodeNetworkConfig nodeNetworkConfig)` Node network config.
`UpdateNodePoolRequest`	`setNodePoolId(String nodePoolId)` Deprecated.
`UpdateNodePoolRequest`	`setNodeVersion(String nodeVersion)` Required.
`UpdateNodePoolRequest`	`setProjectId(String projectId)` Deprecated.
`UpdateNodePoolRequest`	`setResourceLabels(ResourceLabels resourceLabels)` The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
`UpdateNodePoolRequest`	`setTags(NetworkTags tags)` The desired network tags to be applied to all nodes in the node pool.
`UpdateNodePoolRequest`	`setTaints(NodeTaints taints)` The desired node taints to be applied to all nodes in the node pool.
`UpdateNodePoolRequest`	`setUpgradeSettings(UpgradeSettings upgradeSettings)` Upgrade settings control disruption and speed of the upgrade.
`UpdateNodePoolRequest`	`setWindowsNodeConfig(WindowsNodeConfig windowsNodeConfig)` Parameters that can be configured on Windows nodes.
`UpdateNodePoolRequest`	`setWorkloadMetadataConfig(WorkloadMetadataConfig workloadMetadataConfig)` The desired workload metadata config for the node pool.
`UpdateNodePoolRequest`	`setZone(String zone)` Deprecated.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - UpdateNodePoolRequest
```
public UpdateNodePoolRequest()
```
- Method Detail
  - getClusterId
```
public String getClusterId()
```
    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
    
    Returns:
    
    value or null for none
  - setClusterId
```
public UpdateNodePoolRequest setClusterId(String clusterId)
```
    Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
    
    Parameters:
    
    clusterId - clusterId or null for none
  - getConfidentialNodes
```
public ConfidentialNodes getConfidentialNodes()
```
    Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
    
    Returns:
    
    value or null for none
  - setConfidentialNodes
```
public UpdateNodePoolRequest setConfidentialNodes(ConfidentialNodes confidentialNodes)
```
    Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
    
    Parameters:
    
    confidentialNodes - confidentialNodes or null for none
  - getEtag
```
public 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.
    
    Returns:
    
    value or null for none
  - setEtag
```
public UpdateNodePoolRequest setEtag(String etag)
```
    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.
    
    Parameters:
    
    etag - etag or null for none
  - getFastSocket
```
public FastSocket getFastSocket()
```
    Enable or disable NCCL fast socket for the node pool.
    
    Returns:
    
    value or null for none
  - setFastSocket
```
public UpdateNodePoolRequest setFastSocket(FastSocket fastSocket)
```
    Enable or disable NCCL fast socket for the node pool.
    
    Parameters:
    
    fastSocket - fastSocket or null for none
  - getGcfsConfig
```
public GcfsConfig getGcfsConfig()
```
    GCFS config.
    
    Returns:
    
    value or null for none
  - setGcfsConfig
```
public UpdateNodePoolRequest setGcfsConfig(GcfsConfig gcfsConfig)
```
    GCFS config.
    
    Parameters:
    
    gcfsConfig - gcfsConfig or null for none
  - getGvnic
```
public VirtualNIC getGvnic()
```
    Enable or disable gvnic on the node pool.
    
    Returns:
    
    value or null for none
  - setGvnic
```
public UpdateNodePoolRequest setGvnic(VirtualNIC gvnic)
```
    Enable or disable gvnic on the node pool.
    
    Parameters:
    
    gvnic - gvnic or null for none
  - getImageType
```
public 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.
    
    Returns:
    
    value or null for none
  - setImageType
```
public UpdateNodePoolRequest setImageType(String imageType)
```
    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.
    
    Parameters:
    
    imageType - imageType or null for none
  - getKubeletConfig
```
public NodeKubeletConfig getKubeletConfig()
```
    Node kubelet configs.
    
    Returns:
    
    value or null for none
  - setKubeletConfig
```
public UpdateNodePoolRequest setKubeletConfig(NodeKubeletConfig kubeletConfig)
```
    Node kubelet configs.
    
    Parameters:
    
    kubeletConfig - kubeletConfig or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public UpdateNodePoolRequest setLabels(NodeLabels labels)
```
    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.
    
    Parameters:
    
    labels - labels or null for none
  - getLinuxNodeConfig
```
public LinuxNodeConfig getLinuxNodeConfig()
```
    Parameters that can be configured on Linux nodes.
    
    Returns:
    
    value or null for none
  - setLinuxNodeConfig
```
public UpdateNodePoolRequest setLinuxNodeConfig(LinuxNodeConfig linuxNodeConfig)
```
    Parameters that can be configured on Linux nodes.
    
    Parameters:
    
    linuxNodeConfig - linuxNodeConfig or null for none
  - getLocations
```
public List<String> getLocations()
```
    The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) 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.
    
    Returns:
    
    value or null for none
  - setLocations
```
public UpdateNodePoolRequest setLocations(List<String> locations)
```
    The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) 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.
    
    Parameters:
    
    locations - locations or null for none
  - getLoggingConfig
```
public NodePoolLoggingConfig getLoggingConfig()
```
    Logging configuration.
    
    Returns:
    
    value or null for none
  - setLoggingConfig
```
public UpdateNodePoolRequest setLoggingConfig(NodePoolLoggingConfig loggingConfig)
```
    Logging configuration.
    
    Parameters:
    
    loggingConfig - loggingConfig or null for none
  - 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`.
    
    Returns:
    
    value or null for none
  - setName
```
public UpdateNodePoolRequest setName(String name)
```
    The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/locations/clusters/nodePools`.
    
    Parameters:
    
    name - name or null for none
  - getNodeNetworkConfig
```
public NodeNetworkConfig getNodeNetworkConfig()
```
    Node network config.
    
    Returns:
    
    value or null for none
  - setNodeNetworkConfig
```
public UpdateNodePoolRequest setNodeNetworkConfig(NodeNetworkConfig nodeNetworkConfig)
```
    Node network config.
    
    Parameters:
    
    nodeNetworkConfig - nodeNetworkConfig or null for none
  - getNodePoolId
```
public String getNodePoolId()
```
    Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
    
    Returns:
    
    value or null for none
  - setNodePoolId
```
public UpdateNodePoolRequest setNodePoolId(String nodePoolId)
```
    Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
    
    Parameters:
    
    nodePoolId - nodePoolId or null for none
  - 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
    
    Returns:
    
    value or null for none
  - setNodeVersion
```
public UpdateNodePoolRequest setNodeVersion(String nodeVersion)
```
    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
    
    Parameters:
    
    nodeVersion - nodeVersion or null for none
  - getProjectId
```
public String getProjectId()
```
    Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
    
    Returns:
    
    value or null for none
  - setProjectId
```
public UpdateNodePoolRequest setProjectId(String projectId)
```
    Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
    
    Parameters:
    
    projectId - projectId or null for none
  - getResourceLabels
```
public ResourceLabels getResourceLabels()
```
    The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
    
    Returns:
    
    value or null for none
  - setResourceLabels
```
public UpdateNodePoolRequest setResourceLabels(ResourceLabels resourceLabels)
```
    The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
    
    Parameters:
    
    resourceLabels - resourceLabels or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setTags
```
public UpdateNodePoolRequest setTags(NetworkTags tags)
```
    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.
    
    Parameters:
    
    tags - tags or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setTaints
```
public UpdateNodePoolRequest setTaints(NodeTaints taints)
```
    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.
    
    Parameters:
    
    taints - taints or null for none
  - getUpgradeSettings
```
public UpgradeSettings getUpgradeSettings()
```
    Upgrade settings control disruption and speed of the upgrade.
    
    Returns:
    
    value or null for none
  - setUpgradeSettings
```
public UpdateNodePoolRequest setUpgradeSettings(UpgradeSettings upgradeSettings)
```
    Upgrade settings control disruption and speed of the upgrade.
    
    Parameters:
    
    upgradeSettings - upgradeSettings or null for none
  - getWindowsNodeConfig
```
public WindowsNodeConfig getWindowsNodeConfig()
```
    Parameters that can be configured on Windows nodes.
    
    Returns:
    
    value or null for none
  - setWindowsNodeConfig
```
public UpdateNodePoolRequest setWindowsNodeConfig(WindowsNodeConfig windowsNodeConfig)
```
    Parameters that can be configured on Windows nodes.
    
    Parameters:
    
    windowsNodeConfig - windowsNodeConfig or null for none
  - getWorkloadMetadataConfig
```
public WorkloadMetadataConfig getWorkloadMetadataConfig()
```
    The desired workload metadata config for the node pool.
    
    Returns:
    
    value or null for none
  - setWorkloadMetadataConfig
```
public UpdateNodePoolRequest setWorkloadMetadataConfig(WorkloadMetadataConfig workloadMetadataConfig)
```
    The desired workload metadata config for the node pool.
    
    Parameters:
    
    workloadMetadataConfig - workloadMetadataConfig or null for none
  - getZone
```
public String getZone()
```
    Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
    
    Returns:
    
    value or null for none
  - setZone
```
public UpdateNodePoolRequest setZone(String zone)
```
    Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public UpdateNodePoolRequest set(String fieldName,
                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public UpdateNodePoolRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class UpdateNodePoolRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

UpdateNodePoolRequest

Method Detail

getClusterId

setClusterId

getConfidentialNodes

setConfidentialNodes

getEtag

setEtag

getFastSocket

setFastSocket

getGcfsConfig

setGcfsConfig

getGvnic

setGvnic

getImageType

setImageType

getKubeletConfig

setKubeletConfig

getLabels

setLabels

getLinuxNodeConfig

setLinuxNodeConfig

getLocations

setLocations

getLoggingConfig

setLoggingConfig

getName

setName

getNodeNetworkConfig

setNodeNetworkConfig

getNodePoolId

setNodePoolId

getNodeVersion

setNodeVersion

getProjectId

setProjectId

getResourceLabels

setResourceLabels

getTags

setTags

getTaints

setTaints

getUpgradeSettings

setUpgradeSettings

getWindowsNodeConfig

setWindowsNodeConfig

getWorkloadMetadataConfig

setWorkloadMetadataConfig

getZone

setZone

set

clone