Google Cloud Container V1 Client - Class UpdateNodePoolRequest (2.2.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 Google\Cloud\Container\V1\LinuxNodeConfig

Parameters that can be configured on Linux nodes.
↳ kubelet_config Google\Cloud\Container\V1\NodeKubeletConfig

Node kubelet configs.
↳ node_network_config Google\Cloud\Container\V1\NodeNetworkConfig

Node network config.
↳ gcfs_config Google\Cloud\Container\V1\GcfsConfig

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 Google\Cloud\Container\V1\VirtualNIC

Enable or disable gvnic on the node pool.
↳ 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 Google\Cloud\Container\V1\FastSocket

Enable or disable NCCL fast socket for the node pool.
↳ logging_config Google\Cloud\Container\V1\NodePoolLoggingConfig

Logging configuration.
↳ 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 Google\Cloud\Container\V1\WindowsNodeConfig

Parameters that can be configured on Windows nodes.
↳ accelerators array<Google\Cloud\Container\V1\AcceleratorConfig>

A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
↳ machine_type string

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.
↳ disk_type string

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.
↳ disk_size_gb int|string

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.
↳ resource_manager_tags Google\Cloud\Container\V1\ResourceManagerTags

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.
↳ containerd_config Google\Cloud\Container\V1\ContainerdConfig

The desired containerd config for nodes in the node pool. Initiates an upgrade operation that recreates the nodes with the new config.
↳ queued_provisioning Google\Cloud\Container\V1\NodePool\QueuedProvisioning

Specifies the configuration of queued provisioning.
↳ storage_pools array

List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.

getProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

Returns
Type Description
string

setProjectId

Deprecated. The Google Developers Console project ID or project number.

This field has been deprecated and replaced by the name field.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterId

Deprecated. The name of the cluster to upgrade.

This field has been deprecated and replaced by the name field.

Returns
Type Description
string

setClusterId

Deprecated. The name of the cluster to upgrade.

This field has been deprecated and replaced by the name field.

Parameter
Name Description
var string
Returns
Type Description
$this

getNodePoolId

Deprecated. The name of the node pool to upgrade.

This field has been deprecated and replaced by the name field.

Returns
Type Description
string

setNodePoolId

Deprecated. The name of the node pool to upgrade.

This field has been deprecated and replaced by the name field.

Parameter
Name Description
var string
Returns
Type Description
$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
Returns
Type Description
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
Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getWorkloadMetadataConfig

The desired workload metadata config for the node pool.

Returns
Type Description
Google\Cloud\Container\V1\WorkloadMetadataConfig|null

hasWorkloadMetadataConfig

clearWorkloadMetadataConfig

setWorkloadMetadataConfig

The desired workload metadata config for the node pool.

Parameter
Name Description
var Google\Cloud\Container\V1\WorkloadMetadataConfig
Returns
Type Description
$this

getUpgradeSettings

Upgrade settings control disruption and speed of the upgrade.

Returns
Type Description
Google\Cloud\Container\V1\NodePool\UpgradeSettings|null

hasUpgradeSettings

clearUpgradeSettings

setUpgradeSettings

Upgrade settings control disruption and speed of the upgrade.

Parameter
Name Description
var Google\Cloud\Container\V1\NodePool\UpgradeSettings
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\Container\V1\NetworkTags|null

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.

Parameter
Name Description
var Google\Cloud\Container\V1\NetworkTags
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\Container\V1\NodeTaints|null

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.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeTaints
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\Container\V1\NodeLabels|null

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.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeLabels
Returns
Type Description
$this

getLinuxNodeConfig

Parameters that can be configured on Linux nodes.

Returns
Type Description
Google\Cloud\Container\V1\LinuxNodeConfig|null

hasLinuxNodeConfig

clearLinuxNodeConfig

setLinuxNodeConfig

Parameters that can be configured on Linux nodes.

Parameter
Name Description
var Google\Cloud\Container\V1\LinuxNodeConfig
Returns
Type Description
$this

getKubeletConfig

Node kubelet configs.

Returns
Type Description
Google\Cloud\Container\V1\NodeKubeletConfig|null

hasKubeletConfig

clearKubeletConfig

setKubeletConfig

Node kubelet configs.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeKubeletConfig
Returns
Type Description
$this

getNodeNetworkConfig

Node network config.

Returns
Type Description
Google\Cloud\Container\V1\NodeNetworkConfig|null

hasNodeNetworkConfig

clearNodeNetworkConfig

setNodeNetworkConfig

Node network config.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeNetworkConfig
Returns
Type Description
$this

getGcfsConfig

GCFS config.

Returns
Type Description
Google\Cloud\Container\V1\GcfsConfig|null

hasGcfsConfig

clearGcfsConfig

setGcfsConfig

GCFS config.

Parameter
Name Description
var Google\Cloud\Container\V1\GcfsConfig
Returns
Type Description
$this

getConfidentialNodes

Confidential nodes config.

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

Returns
Type Description
Google\Cloud\Container\V1\ConfidentialNodes|null

hasConfidentialNodes

clearConfidentialNodes

setConfidentialNodes

Confidential nodes config.

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

Parameter
Name Description
var Google\Cloud\Container\V1\ConfidentialNodes
Returns
Type Description
$this

getGvnic

Enable or disable gvnic on the node pool.

Returns
Type Description
Google\Cloud\Container\V1\VirtualNIC|null

hasGvnic

clearGvnic

setGvnic

Enable or disable gvnic on the node pool.

Parameter
Name Description
var Google\Cloud\Container\V1\VirtualNIC
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFastSocket

Enable or disable NCCL fast socket for the node pool.

Returns
Type Description
Google\Cloud\Container\V1\FastSocket|null

hasFastSocket

clearFastSocket

setFastSocket

Enable or disable NCCL fast socket for the node pool.

Parameter
Name Description
var Google\Cloud\Container\V1\FastSocket
Returns
Type Description
$this

getLoggingConfig

Logging configuration.

Returns
Type Description
Google\Cloud\Container\V1\NodePoolLoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Logging configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\NodePoolLoggingConfig
Returns
Type Description
$this

getResourceLabels

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

Returns
Type Description
Google\Cloud\Container\V1\ResourceLabels|null

hasResourceLabels

clearResourceLabels

setResourceLabels

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

Parameter
Name Description
var Google\Cloud\Container\V1\ResourceLabels
Returns
Type Description
$this

getWindowsNodeConfig

Parameters that can be configured on Windows nodes.

Returns
Type Description
Google\Cloud\Container\V1\WindowsNodeConfig|null

hasWindowsNodeConfig

clearWindowsNodeConfig

setWindowsNodeConfig

Parameters that can be configured on Windows nodes.

Parameter
Name Description
var Google\Cloud\Container\V1\WindowsNodeConfig
Returns
Type Description
$this

getAccelerators

A list of hardware accelerators to be attached to each node.

See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAccelerators

A list of hardware accelerators to be attached to each node.

See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

Parameter
Name Description
var array<Google\Cloud\Container\V1\AcceleratorConfig>
Returns
Type Description
$this

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.

Returns
Type Description
string

setMachineType

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setDiskType

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int|string

setDiskSizeGb

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.

Parameter
Name Description
var int|string
Returns
Type Description
$this

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.

Returns
Type Description
Google\Cloud\Container\V1\ResourceManagerTags|null

hasResourceManagerTags

clearResourceManagerTags

setResourceManagerTags

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.

Parameter
Name Description
var Google\Cloud\Container\V1\ResourceManagerTags
Returns
Type Description
$this

getContainerdConfig

The desired containerd config for nodes in the node pool.

Initiates an upgrade operation that recreates the nodes with the new config.

Returns
Type Description
Google\Cloud\Container\V1\ContainerdConfig|null

hasContainerdConfig

clearContainerdConfig

setContainerdConfig

The desired containerd config for nodes in the node pool.

Initiates an upgrade operation that recreates the nodes with the new config.

Parameter
Name Description
var Google\Cloud\Container\V1\ContainerdConfig
Returns
Type Description
$this

getQueuedProvisioning

Specifies the configuration of queued provisioning.

Returns
Type Description
Google\Cloud\Container\V1\NodePool\QueuedProvisioning|null

hasQueuedProvisioning

clearQueuedProvisioning

setQueuedProvisioning

Specifies the configuration of queued provisioning.

Parameter
Name Description
var Google\Cloud\Container\V1\NodePool\QueuedProvisioning
Returns
Type Description
$this

getStoragePools

List of Storage Pools where boot disks are provisioned.

Existing Storage Pools will be replaced with storage-pools.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setStoragePools

List of Storage Pools where boot disks are provisioned.

Existing Storage Pools will be replaced with storage-pools.

Parameter
Name Description
var string[]
Returns
Type Description
$this