Reference documentation and code samples for the Google Cloud Container V1 Client class UpdateNodePoolRequest.
UpdateNodePoolRequests update a node pool's image and/or version.
Generated from protobuf message google.container.v1.UpdateNodePoolRequest
Namespace
Google \ Cloud \ Container \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ project_id
string
Deprecated. The Google Developers Console project ID or project number . This field has been deprecated and replaced by the name field.
↳ zone
string
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.
↳ cluster_id
string
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
↳ node_pool_id
string
Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
↳ node_version
string
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
↳ image_type
string
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.
↳ name
string
The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*
.
↳ locations
array
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.
↳ workload_metadata_config
Google\Cloud\Container\V1\WorkloadMetadataConfig
The desired workload metadata config for the node pool.
↳ upgrade_settings
Google\Cloud\Container\V1\NodePool\UpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
↳ tags
Google\Cloud\Container\V1\NetworkTags
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.
↳ taints
Google\Cloud\Container\V1\NodeTaints
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.
↳ labels
Google\Cloud\Container\V1\NodeLabels
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.
↳ linux_node_config
↳ kubelet_config
↳ node_network_config
↳ gcfs_config
↳ confidential_nodes
Google\Cloud\Container\V1\ConfidentialNodes
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
↳ gvnic
↳ etag
string
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.
↳ fast_socket
↳ logging_config
↳ resource_labels
Google\Cloud\Container\V1\ResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
↳ windows_node_config
getProjectId
Deprecated. The Google Developers Console project ID or project number .
This field has been deprecated and replaced by the name field.
string
setProjectId
Deprecated. The Google Developers Console project ID or project number .
This field has been deprecated and replaced by the name field.
var
string
$this
getZone
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
setZone
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.
var
string
$this
getClusterId
Deprecated. The name of the cluster to upgrade.
This field has been deprecated and replaced by the name field.
string
setClusterId
Deprecated. The name of the cluster to upgrade.
This field has been deprecated and replaced by the name field.
var
string
$this
getNodePoolId
Deprecated. The name of the node pool to upgrade.
This field has been deprecated and replaced by the name field.
string
setNodePoolId
Deprecated. The name of the node pool to upgrade.
This field has been deprecated and replaced by the name field.
var
string
$this
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
setNodeVersion
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
var
string
$this
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
setImageType
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.
var
string
$this
getName
The name (project, location, cluster, node pool) of the node pool to
update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*
.
string
setName
The name (project, location, cluster, node pool) of the node pool to
update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*
.
var
string
$this
getLocations
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.
setLocations
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.
var
string[]
$this
getWorkloadMetadataConfig
The desired workload metadata config for the node pool.
hasWorkloadMetadataConfig
clearWorkloadMetadataConfig
setWorkloadMetadataConfig
The desired workload metadata config for the node pool.
$this
getUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
hasUpgradeSettings
clearUpgradeSettings
setUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
$this
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.
hasTags
clearTags
setTags
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.
$this
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.
hasTaints
clearTaints
setTaints
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.
$this
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.
hasLabels
clearLabels
setLabels
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.
$this
getLinuxNodeConfig
Parameters that can be configured on Linux nodes.
hasLinuxNodeConfig
clearLinuxNodeConfig
setLinuxNodeConfig
Parameters that can be configured on Linux nodes.
$this
getKubeletConfig
Node kubelet configs.
hasKubeletConfig
clearKubeletConfig
setKubeletConfig
Node kubelet configs.
$this
getNodeNetworkConfig
Node network config.
hasNodeNetworkConfig
clearNodeNetworkConfig
setNodeNetworkConfig
Node network config.
$this
getGcfsConfig
GCFS config.
hasGcfsConfig
clearGcfsConfig
setGcfsConfig
GCFS config.
$this
getConfidentialNodes
Confidential nodes config.
All the nodes in the node pool will be Confidential VM once enabled.
hasConfidentialNodes
clearConfidentialNodes
setConfidentialNodes
Confidential nodes config.
All the nodes in the node pool will be Confidential VM once enabled.
$this
getGvnic
Enable or disable gvnic on the node pool.
hasGvnic
clearGvnic
setGvnic
Enable or disable gvnic on the node pool.
$this
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
setEtag
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.
var
string
$this
getFastSocket
Enable or disable NCCL fast socket for the node pool.
hasFastSocket
clearFastSocket
setFastSocket
Enable or disable NCCL fast socket for the node pool.
$this
getLoggingConfig
Logging configuration.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration.
$this
getResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
hasResourceLabels
clearResourceLabels
setResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
$this
getWindowsNodeConfig
Parameters that can be configured on Windows nodes.
hasWindowsNodeConfig
clearWindowsNodeConfig
setWindowsNodeConfig
Parameters that can be configured on Windows nodes.
$this
