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
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. |
↳ name |
string
The name (project, ___location, cluster, node pool) of the node pool to update. Specified in the format |
↳ 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. |
↳ 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. |
getProjectId
Deprecated. The Google Developers Console project ID or project number.
This field has been deprecated and replaced by the name field.
Generated from protobuf field string project_id = 1 [deprecated = true];
| 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.
Generated from protobuf field string project_id = 1 [deprecated = true];
| 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.
Generated from protobuf field string zone = 2 [deprecated = true];
| 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.
Generated from protobuf field string zone = 2 [deprecated = true];
| 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.
Generated from protobuf field string cluster_id = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
string |
|
setClusterId
Deprecated. The name of the cluster to upgrade.
This field has been deprecated and replaced by the name field.
Generated from protobuf field string cluster_id = 3 [deprecated = true];
| 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.
Generated from protobuf field string node_pool_id = 4 [deprecated = true];
| 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.
Generated from protobuf field string node_pool_id = 4 [deprecated = true];
| 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
Generated from protobuf field string node_version = 5 [(.google.api.field_behavior) = REQUIRED];
| 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
Generated from protobuf field string node_version = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImageType
Required. The desired image type for the node pool.
Generated from protobuf field string image_type = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string |
|
setImageType
Required. The desired image type for the node pool.
Generated from protobuf field string image_type = 6 [(.google.api.field_behavior) = REQUIRED];
| 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/*.
Generated from protobuf field string name = 8;
| 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/*.
Generated from protobuf field string name = 8;
| 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.
Generated from protobuf field repeated string locations = 13;
| 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.
Generated from protobuf field repeated string locations = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkloadMetadataConfig
The desired workload metadata config for the node pool.
Generated from protobuf field .google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\WorkloadMetadataConfig|null |
|
hasWorkloadMetadataConfig
clearWorkloadMetadataConfig
setWorkloadMetadataConfig
The desired workload metadata config for the node pool.
Generated from protobuf field .google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\WorkloadMetadataConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
Generated from protobuf field .google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\NodePool\UpgradeSettings|null |
|
hasUpgradeSettings
clearUpgradeSettings
setUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
Generated from protobuf field .google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;
| 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.
Generated from protobuf field .google.container.v1.NetworkTags tags = 16;
| 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.
Generated from protobuf field .google.container.v1.NetworkTags tags = 16;
| 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.
Generated from protobuf field .google.container.v1.NodeTaints taints = 17;
| 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.
Generated from protobuf field .google.container.v1.NodeTaints taints = 17;
| 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.
Generated from protobuf field .google.container.v1.NodeLabels labels = 18;
| 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.
Generated from protobuf field .google.container.v1.NodeLabels labels = 18;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\NodeLabels
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLinuxNodeConfig
Parameters that can be configured on Linux nodes.
Generated from protobuf field .google.container.v1.LinuxNodeConfig linux_node_config = 19;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\LinuxNodeConfig|null |
|
hasLinuxNodeConfig
clearLinuxNodeConfig
setLinuxNodeConfig
Parameters that can be configured on Linux nodes.
Generated from protobuf field .google.container.v1.LinuxNodeConfig linux_node_config = 19;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\LinuxNodeConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKubeletConfig
Node kubelet configs.
Generated from protobuf field .google.container.v1.NodeKubeletConfig kubelet_config = 20;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\NodeKubeletConfig|null |
|
hasKubeletConfig
clearKubeletConfig
setKubeletConfig
Node kubelet configs.
Generated from protobuf field .google.container.v1.NodeKubeletConfig kubelet_config = 20;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\NodeKubeletConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodeNetworkConfig
Node network config.
Generated from protobuf field .google.container.v1.NodeNetworkConfig node_network_config = 21;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\NodeNetworkConfig|null |
|
hasNodeNetworkConfig
clearNodeNetworkConfig
setNodeNetworkConfig
Node network config.
Generated from protobuf field .google.container.v1.NodeNetworkConfig node_network_config = 21;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\NodeNetworkConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcfsConfig
GCFS config.
Generated from protobuf field .google.container.v1.GcfsConfig gcfs_config = 22;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\GcfsConfig|null |
|
hasGcfsConfig
clearGcfsConfig
setGcfsConfig
GCFS config.
Generated from protobuf field .google.container.v1.GcfsConfig gcfs_config = 22;
| 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.
Generated from protobuf field .google.container.v1.ConfidentialNodes confidential_nodes = 23;
| 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.
Generated from protobuf field .google.container.v1.ConfidentialNodes confidential_nodes = 23;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\ConfidentialNodes
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGvnic
Enable or disable gvnic on the node pool.
Generated from protobuf field .google.container.v1.VirtualNIC gvnic = 29;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\VirtualNIC|null |
|
hasGvnic
clearGvnic
setGvnic
Enable or disable gvnic on the node pool.
Generated from protobuf field .google.container.v1.VirtualNIC gvnic = 29;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\VirtualNIC
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFastSocket
Enable or disable NCCL fast socket for the node pool.
Generated from protobuf field .google.container.v1.FastSocket fast_socket = 31;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\FastSocket|null |
|
hasFastSocket
clearFastSocket
setFastSocket
Enable or disable NCCL fast socket for the node pool.
Generated from protobuf field .google.container.v1.FastSocket fast_socket = 31;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\FastSocket
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoggingConfig
Logging configuration.
Generated from protobuf field .google.container.v1.NodePoolLoggingConfig logging_config = 32;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Container\V1\NodePoolLoggingConfig|null |
|
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration.
Generated from protobuf field .google.container.v1.NodePoolLoggingConfig logging_config = 32;
| 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.
Generated from protobuf field .google.container.v1.ResourceLabels resource_labels = 33;
| 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.
Generated from protobuf field .google.container.v1.ResourceLabels resource_labels = 33;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Container\V1\ResourceLabels
|
| Returns | |
|---|---|
| Type | Description |
$this |
|