- 2.54.0 (latest)
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.1
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.4
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.2
- 2.10.8
- 2.9.0
- 2.8.1
- 2.7.1
- 2.6.1
- 2.5.0
- 2.4.1
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.1
- 1.0.3
- 0.5.0
- 0.4.0
- 0.3.0
ClusterManagerClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)Google Kubernetes Engine Cluster Manager v1
Methods
ClusterManagerClient
ClusterManagerClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)Constructor.
| Parameters | |
|---|---|
| Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
credentials |
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to |
client_config |
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used. |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
client_options |
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options. |
cancel_operation
cancel_operation(project_id=None, zone=None, operation_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Cancels the specified operation.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
client.cancel_operation()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
operation_id |
str
Deprecated. The server-assigned |
name |
str
The name (project, location, operation id) of the operation to cancel. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
complete_i_p_rotation
complete_i_p_rotation(project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Completes master IP rotation.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.complete_i_p_rotation()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
create_cluster
create_cluster(cluster, project_id=None, zone=None, parent=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
By default, the cluster is created in the project's default
network <https://cloud.google.com/compute/docs/networks-and-firewalls#networks>__.
One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster.
Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
cluster:cluster = {}
response = client.create_cluster(cluster)
| Parameters | |
|---|---|
| Name | Description |
cluster |
Union[dict, Cluster]
Required. A |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
parent |
str
The parent (project and location) where the cluster will be created. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
create_node_pool
create_node_pool(node_pool, project_id=None, zone=None, cluster_id=None, parent=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Creates a node pool for a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
node_pool:node_pool = {}
response = client.create_node_pool(node_pool)
| Parameters | |
|---|---|
| Name | Description |
node_pool |
Union[dict, NodePool]
Required. The node pool to create. If a dict is provided, it must be of the same form as the protobuf message NodePool |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. |
parent |
str
The parent (project, location, cluster id) where the node pool will be created. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
delete_cluster
delete_cluster(project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
Firewalls and routes that were configured during cluster creation are also deleted.
Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.delete_cluster()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to delete. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
delete_node_pool
delete_node_pool(project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Deletes a node pool from a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.delete_node_pool()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
ClusterManagerClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
ClusterManagerClient | The constructed client. |
get_cluster
get_cluster(project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Gets the details of a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.get_cluster()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to retrieve. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
get_node_pool
get_node_pool(project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Retrieves the requested node pool.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.get_node_pool()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
get_operation
get_operation(project_id=None, zone=None, operation_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Gets the specified operation.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.get_operation()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
operation_id |
str
Deprecated. The server-assigned |
name |
str
The name (project, location, operation id) of the operation to get. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
get_server_config
get_server_config(project_id=None, zone=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Returns configuration info about the Google Kubernetes Engine service.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.get_server_config()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
name |
str
The name (project and location) of the server config to get, specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_clusters
list_clusters(project_id=None, zone=None, parent=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Lists all clusters owned by a project in either the specified zone or all zones.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.list_clusters()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
parent |
str
The parent (project and location) where the clusters will be listed. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_node_pools
list_node_pools(project_id=None, zone=None, cluster_id=None, parent=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Lists the node pools for a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.list_node_pools()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. |
parent |
str
The parent (project, location, cluster id) where the node pools will be listed. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_operations
list_operations(project_id=None, zone=None, parent=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Lists all operations in a project in a specific zone or all zones.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.list_operations()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
parent |
str
The parent (project and location) where the operations will be listed. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_usable_subnetworks
list_usable_subnetworks(parent=None, filter_=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Lists subnetworks that are usable for creating clusters in a project.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
Iterate over all results
for element in client.list_usable_subnetworks(): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_usable_subnetworks().pages: ... for element in page: ... # process element ... pass
| Parameters | |
|---|---|
| Name | Description |
parent |
str
The parent project where subnetworks are usable. Specified in the format |
filter_ |
str
Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
rollback_node_pool_upgrade
rollback_node_pool_upgrade(project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.rollback_node_pool_upgrade()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_addons_config
set_addons_config(addons_config, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the addons for a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
addons_config:addons_config = {}
response = client.set_addons_config(addons_config)
| Parameters | |
|---|---|
| Name | Description |
addons_config |
Union[dict, AddonsConfig]
Required. The desired configurations for the various addons available to run in the cluster. If a dict is provided, it must be of the same form as the protobuf message AddonsConfig |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to set addons. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_labels
set_labels(resource_labels, label_fingerprint, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets labels on a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
resource_labels:resource_labels = {}
TODO: Initialize
label_fingerprint:label_fingerprint = ''
response = client.set_labels(resource_labels, label_fingerprint)
| Parameters | |
|---|---|
| Name | Description |
resource_labels |
dict[str -> str]
Required. The labels to set for that cluster. |
label_fingerprint |
str
Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster id) of the cluster to set labels. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_legacy_abac
set_legacy_abac(enabled, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Enables or disables the ABAC authorization mechanism on a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
enabled:enabled = False
response = client.set_legacy_abac(enabled)
| Parameters | |
|---|---|
| Name | Description |
enabled |
bool
Required. Whether ABAC authorization will be enabled in the cluster. |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_locations
set_locations(locations, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the locations for a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
locations:locations = []
response = client.set_locations(locations)
| Parameters | |
|---|---|
| Name | Description |
locations |
list[str]
Required. The desired list of Google Compute Engine |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to set locations. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_logging_service
set_logging_service(logging_service, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the logging service for a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
logging_service:logging_service = ''
response = client.set_logging_service(logging_service)
| Parameters | |
|---|---|
| Name | Description |
logging_service |
str
Required. The logging service the cluster should use to write metrics. Currently available options: - "logging.googleapis.com" - the Google Cloud Logging service - "none" - no metrics will be exported from the cluster |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to set logging. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_maintenance_policy
set_maintenance_policy(project_id, zone, cluster_id, maintenance_policy, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the maintenance policy for a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
project_id:project_id = ''
TODO: Initialize
zone:zone = ''
TODO: Initialize
cluster_id:cluster_id = ''
TODO: Initialize
maintenance_policy:maintenance_policy = {}
response = client.set_maintenance_policy(project_id, zone, cluster_id, maintenance_policy)
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Required. The Google Developers Console |
zone |
str
Required. The name of the Google Compute Engine |
cluster_id |
str
Required. The name of the cluster to update. |
maintenance_policy |
Union[dict, MaintenancePolicy]
Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy. If a dict is provided, it must be of the same form as the protobuf message MaintenancePolicy |
name |
str
The name (project, location, cluster id) of the cluster to set maintenance policy. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_master_auth
set_master_auth(action, update, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
.. rubric:: Example
from google.cloud import container_v1 from google.cloud.container_v1 import enums
client = container_v1.ClusterManagerClient()
TODO: Initialize
action:action = enums.SetMasterAuthRequest.Action.UNKNOWN
TODO: Initialize
update:update = {}
response = client.set_master_auth(action, update)
| Parameters | |
|---|---|
| Name | Description |
action |
Action
Required. The exact form of action to be taken on the master auth. |
update |
Union[dict, MasterAuth]
Required. A description of the update. If a dict is provided, it must be of the same form as the protobuf message MasterAuth |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to set auth. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_monitoring_service
set_monitoring_service(monitoring_service, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the monitoring service for a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
monitoring_service:monitoring_service = ''
response = client.set_monitoring_service(monitoring_service)
| Parameters | |
|---|---|
| Name | Description |
monitoring_service |
str
Required. The monitoring service the cluster should use to write metrics. Currently available options: - "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model - "monitoring.googleapis.com" - the Google Cloud Monitoring service - "none" - no metrics will be exported from the cluster |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to set monitoring. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_network_policy
set_network_policy(network_policy, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Enables or disables Network Policy for a cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
network_policy:network_policy = {}
response = client.set_network_policy(network_policy)
| Parameters | |
|---|---|
| Name | Description |
network_policy |
Union[dict, NetworkPolicy]
Required. Configuration options for the NetworkPolicy feature. If a dict is provided, it must be of the same form as the protobuf message NetworkPolicy |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_node_pool_autoscaling
set_node_pool_autoscaling(autoscaling, project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the autoscaling settings for the specified node pool.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
autoscaling:autoscaling = {}
response = client.set_node_pool_autoscaling(autoscaling)
| Parameters | |
|---|---|
| Name | Description |
autoscaling |
Union[dict, NodePoolAutoscaling]
Required. Autoscaling configuration for the node pool. If a dict is provided, it must be of the same form as the protobuf message NodePoolAutoscaling |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_node_pool_management
set_node_pool_management(management, project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the NodeManagement options for a node pool.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
management:management = {}
response = client.set_node_pool_management(management)
| Parameters | |
|---|---|
| Name | Description |
management |
Union[dict, NodeManagement]
Required. NodeManagement configuration for the node pool. If a dict is provided, it must be of the same form as the protobuf message NodeManagement |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_node_pool_size
set_node_pool_size(node_count, project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Sets the size for a specific node pool.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
node_count:node_count = 0
response = client.set_node_pool_size(node_count)
| Parameters | |
|---|---|
| Name | Description |
node_count |
int
Required. The desired node count for the pool. |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
start_i_p_rotation
start_i_p_rotation(project_id=None, zone=None, cluster_id=None, name=None, rotate_credentials=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Starts master IP rotation.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
response = client.start_i_p_rotation()
| Parameters | |
|---|---|
| Name | Description |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster id) of the cluster to start IP rotation. Specified in the format |
rotate_credentials |
bool
Whether to rotate credentials during IP rotation. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
update_cluster
update_cluster(update, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Updates the settings of a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
update:update = {}
response = client.update_cluster(update)
| Parameters | |
|---|---|
| Name | Description |
update |
Union[dict, ClusterUpdate]
Required. A description of the update. If a dict is provided, it must be of the same form as the protobuf message ClusterUpdate |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to update. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
update_master
update_master(master_version, project_id=None, zone=None, cluster_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Updates the master for a specific cluster.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
master_version:master_version = ''
response = client.update_master(master_version)
| Parameters | |
|---|---|
| Name | Description |
master_version |
str
Required. The Kubernetes version to change the master to. 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 default Kubernetes version |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster) of the cluster to update. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
update_node_pool
update_node_pool(node_version, image_type, project_id=None, zone=None, cluster_id=None, node_pool_id=None, name=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)Updates the version and/or image type for the specified node pool.
.. rubric:: Example
from google.cloud import container_v1
client = container_v1.ClusterManagerClient()
TODO: Initialize
node_version:node_version = ''
TODO: Initialize
image_type:image_type = ''
response = client.update_node_pool(node_version, image_type)
| Parameters | |
|---|---|
| Name | Description |
node_version |
str
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 |
str
Required. The desired image type for the node pool. |
project_id |
str
Deprecated. The Google Developers Console |
zone |
str
Deprecated. The name of the Google Compute Engine |
cluster_id |
str
Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. |
node_pool_id |
str
Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. |
name |
str
The name (project, location, cluster, node pool) of the node pool to update. Specified in the format |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
| Exceptions | |
|---|---|
| Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |