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.
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 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
↳ 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.
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];
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];
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.
Generated from protobuf field string zone = 2 [deprecated = true];
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];
var
string
$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];
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];
var
string
$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];
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];
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
Generated from protobuf field string node_version = 5 [(.google.api.field_behavior) = REQUIRED];
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];
var
string
$this
getImageType
Required. The desired image type for the node pool.
Generated from protobuf field string image_type = 6 [(.google.api.field_behavior) = REQUIRED];
string
setImageType
Required. The desired image type for the node pool.
Generated from protobuf field string image_type = 6 [(.google.api.field_behavior) = REQUIRED];
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/*
.
Generated from protobuf field string name = 8;
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;
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.
Generated from protobuf field repeated string locations = 13;
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;
var
string[]
$this
getWorkloadMetadataConfig
The desired workload metadata config for the node pool.
Generated from protobuf field .google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;
hasWorkloadMetadataConfig
clearWorkloadMetadataConfig
setWorkloadMetadataConfig
The desired workload metadata config for the node pool.
Generated from protobuf field .google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;
$this
getUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
Generated from protobuf field .google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;
hasUpgradeSettings
clearUpgradeSettings
setUpgradeSettings
Upgrade settings control disruption and speed of the upgrade.
Generated from protobuf field .google.container.v1.NodePool.UpgradeSettings upgrade_settings = 15;
$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;
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;
$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;
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;
$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;
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;
$this
getLinuxNodeConfig
Parameters that can be configured on Linux nodes.
Generated from protobuf field .google.container.v1.LinuxNodeConfig linux_node_config = 19;
hasLinuxNodeConfig
clearLinuxNodeConfig
setLinuxNodeConfig
Parameters that can be configured on Linux nodes.
Generated from protobuf field .google.container.v1.LinuxNodeConfig linux_node_config = 19;
$this
getKubeletConfig
Node kubelet configs.
Generated from protobuf field .google.container.v1.NodeKubeletConfig kubelet_config = 20;
hasKubeletConfig
clearKubeletConfig
setKubeletConfig
Node kubelet configs.
Generated from protobuf field .google.container.v1.NodeKubeletConfig kubelet_config = 20;
$this
getNodeNetworkConfig
Node network config.
Generated from protobuf field .google.container.v1.NodeNetworkConfig node_network_config = 21;
hasNodeNetworkConfig
clearNodeNetworkConfig
setNodeNetworkConfig
Node network config.
Generated from protobuf field .google.container.v1.NodeNetworkConfig node_network_config = 21;
$this
getGcfsConfig
GCFS config.
Generated from protobuf field .google.container.v1.GcfsConfig gcfs_config = 22;
hasGcfsConfig
clearGcfsConfig
setGcfsConfig
GCFS config.
Generated from protobuf field .google.container.v1.GcfsConfig gcfs_config = 22;
$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;
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;
$this
getGvnic
Enable or disable gvnic on the node pool.
Generated from protobuf field .google.container.v1.VirtualNIC gvnic = 29;
hasGvnic
clearGvnic
setGvnic
Enable or disable gvnic on the node pool.
Generated from protobuf field .google.container.v1.VirtualNIC gvnic = 29;
$this
getFastSocket
Enable or disable NCCL fast socket for the node pool.
Generated from protobuf field .google.container.v1.FastSocket fast_socket = 31;
hasFastSocket
clearFastSocket
setFastSocket
Enable or disable NCCL fast socket for the node pool.
Generated from protobuf field .google.container.v1.FastSocket fast_socket = 31;
$this
getLoggingConfig
Logging configuration.
Generated from protobuf field .google.container.v1.NodePoolLoggingConfig logging_config = 32;
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration.
Generated from protobuf field .google.container.v1.NodePoolLoggingConfig logging_config = 32;
$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;
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;
$this