Client for Google Container Engine API#
-
class
google.cloud.container_v1.
ClusterManagerClient
(transport=None, channel=None, credentials=None, client_config=None, client_info=None, client_options=None)[source]# Google Kubernetes Engine Cluster Manager v1
Constructor.
- Parameters
(Union[ClusterManagerGrpcTransport, (transport) – Callable[[~.Credentials, type], ~.ClusterManagerGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.
channel (grpc.Channel) – DEPRECATED. A
Channel
instance through which to make calls. This argument is mutually exclusive withcredentials
; providing both will raise an exception.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
transport
; doing so will raise an exception.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
None
, then default info will be used. Generally, you only need to set this if you’re developing your own client library.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
(project_id, zone, operation_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Cancels the specified operation.
Example
>>> from google.cloud import container_v1 >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> # TODO: Initialize `operation_id`: >>> operation_id = '' >>> >>> client.cancel_operation(project_id, zone, operation_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – Deprecated. The name of the Google Compute Engine zone in which the operation resides. This field has been deprecated and replaced by the name field.
operation_id (str) – Deprecated. The server-assigned
name
of the operation. This field has been deprecated and replaced by the name field.name (str) – The name (project, location, operation id) of the operation to cancel. Specified in the format ‘projects//locations//operations/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Raises
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
(project_id, zone, cluster_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Completes master IP rotation.
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 = '' >>> >>> response = client.complete_i_p_rotation(project_id, zone, cluster_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster, parent=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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.
One firewall is added for the cluster. After cluster creation, the cluster 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 is being used by the cluster.
Example
>>> from google.cloud import container_v1 >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> # TODO: Initialize `cluster`: >>> cluster = {} >>> >>> response = client.create_cluster(project_id, zone, cluster)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone (str) – Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
cluster (Union[dict, Cluster]) –
If a dict is provided, it must be of the same form as the protobuf message
Cluster
parent (str) – The parent (project and location) where the cluster will be created. Specified in the format ‘projects//locations/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, node_pool, parent=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Creates a node pool for a cluster.
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 `node_pool`: >>> node_pool = {} >>> >>> response = client.create_node_pool(project_id, zone, cluster_id, node_pool)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone (str) – Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
cluster_id (str) – Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
node_pool (Union[dict, NodePool]) –
The node pool to create.
If a dict is provided, it must be of the same form as the protobuf message
NodePool
parent (str) – The parent (project, location, cluster id) where the node pool will be created. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# 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 (e.g. load balancer resources) will not be deleted if they weren’t present at the initial create time.
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 = '' >>> >>> response = client.delete_cluster(project_id, zone, cluster_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Deletes a node pool from a cluster.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> response = client.delete_node_pool(project_id, zone, cluster_id, node_pool_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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.
-
enums
= <module 'google.cloud.container_v1.gapic.enums' from '/usr/local/lib/python3.7/site-packages/google/cloud/container_v1/gapic/enums.py'>#
-
classmethod
from_service_account_file
(filename, *args, **kwargs)[source]# Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
classmethod
from_service_account_json
(filename, *args, **kwargs)# Creates an instance of this client using the provided credentials file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
-
get_cluster
(project_id, zone, cluster_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Gets the details of a specific cluster.
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 = '' >>> >>> response = client.get_cluster(project_id, zone, cluster_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Cluster
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Retrieves the node pool requested.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> response = client.get_node_pool(project_id, zone, cluster_id, node_pool_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
NodePool
instance.- Raises
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
(project_id, zone, operation_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Gets the specified operation.
Example
>>> from google.cloud import container_v1 >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> # TODO: Initialize `operation_id`: >>> operation_id = '' >>> >>> response = client.get_operation(project_id, zone, operation_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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.
operation_id (str) – Deprecated. The server-assigned
name
of the operation. This field has been deprecated and replaced by the name field.name (str) – The name (project, location, operation id) of the operation to get. Specified in the format ‘projects//locations//operations/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Returns configuration info about the Kubernetes Engine service.
Example
>>> from google.cloud import container_v1 >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> response = client.get_server_config(project_id, zone)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – Deprecated. The name of the Google Compute Engine zone to return operations for. This field has been deprecated and replaced by the name field.
name (str) – The name (project and location) of the server config to get Specified in the format ‘projects//locations/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
ServerConfig
instance.- Raises
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
(project_id, zone, parent=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Lists all clusters owned by a project in either the specified zone or all zones.
Example
>>> from google.cloud import container_v1 >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> response = client.list_clusters(project_id, zone)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone (str) – Deprecated. The name of the Google Compute Engine zone in which the cluster resides, or “-” for all zones. This field has been deprecated and replaced by the parent field.
parent (str) – The parent (project and location) where the clusters will be listed. Specified in the format ‘projects//locations/’. Location “-” matches all zones and all regions.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
ListClustersResponse
instance.- Raises
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
(project_id, zone, cluster_id, parent=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Lists the node pools for a cluster.
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 = '' >>> >>> response = client.list_node_pools(project_id, zone, cluster_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone (str) – Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the parent field.
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 ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
ListNodePoolsResponse
instance.- Raises
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
(project_id, zone, parent=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Lists all operations in a project in a specific zone or all zones.
Example
>>> from google.cloud import container_v1 >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> response = client.list_operations(project_id, zone)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the parent field.
zone (str) – Deprecated. The name of the Google Compute Engine zone to return operations for, or
-
for all zones. This field has been deprecated and replaced by the parent field.parent (str) – The parent (project and location) where the operations will be listed. Specified in the format ‘projects//locations/’. Location “-” matches all zones and all regions.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
ListOperationsResponse
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> response = client.rollback_node_pool_upgrade(project_id, zone, cluster_id, node_pool_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, addons_config, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the addons for a specific cluster.
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 `addons_config`: >>> addons_config = {} >>> >>> response = client.set_addons_config(project_id, zone, cluster_id, addons_config)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
addons_config (Union[dict, AddonsConfig]) –
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
name (str) – The name (project, location, cluster) of the cluster to set addons. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, resource_labels, label_fingerprint, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets labels on a cluster.
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 `resource_labels`: >>> resource_labels = {} >>> >>> # TODO: Initialize `label_fingerprint`: >>> label_fingerprint = '' >>> >>> response = client.set_labels(project_id, zone, cluster_id, resource_labels, label_fingerprint)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
resource_labels (dict[str -> str]) – The labels to set for that cluster.
label_fingerprint (str) – 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 <code>get()</code> request to the resource to get the latest fingerprint.
name (str) – The name (project, location, cluster id) of the cluster to set labels. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, enabled, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Enables or disables the ABAC authorization mechanism on a cluster.
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 `enabled`: >>> enabled = False >>> >>> response = client.set_legacy_abac(project_id, zone, cluster_id, enabled)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
enabled (bool) – Whether ABAC authorization will be enabled in the cluster.
name (str) – The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, locations, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the locations for a specific cluster.
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 `locations`: >>> locations = [] >>> >>> response = client.set_locations(project_id, zone, cluster_id, locations)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
The desired list of Google Compute Engine locations in which the cluster’s nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
This list must always include the cluster’s primary zone.
name (str) – The name (project, location, cluster) of the cluster to set locations. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, logging_service, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the logging service for a specific cluster.
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 `logging_service`: >>> logging_service = '' >>> >>> response = client.set_logging_service(project_id, zone, cluster_id, logging_service)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
logging_service (str) –
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
name (str) – The name (project, location, cluster) of the cluster to set logging. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, maintenance_policy, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the maintenance policy for a cluster.
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
project_id (str) – The Google Developers Console project ID or project number.
zone (str) – The name of the Google Compute Engine zone in which the cluster resides.
cluster_id (str) – The name of the cluster to update.
maintenance_policy (Union[dict, MaintenancePolicy]) –
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 ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, action, update, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Used to set master auth materials. Currently supports :- Changing the admin password for a specific cluster. This can be either via password generation or explicitly set the password.
Example
>>> from google.cloud import container_v1 >>> from google.cloud.container_v1 import enums >>> >>> client = container_v1.ClusterManagerClient() >>> >>> # TODO: Initialize `project_id`: >>> project_id = '' >>> >>> # TODO: Initialize `zone`: >>> zone = '' >>> >>> # TODO: Initialize `cluster_id`: >>> cluster_id = '' >>> >>> # TODO: Initialize `action`: >>> action = enums.SetMasterAuthRequest.Action.UNKNOWN >>> >>> # TODO: Initialize `update`: >>> update = {} >>> >>> response = client.set_master_auth(project_id, zone, cluster_id, action, update)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
action (Action) – The exact form of action to be taken on the master auth.
update (Union[dict, MasterAuth]) –
A description of the update.
If a dict is provided, it must be of the same form as the protobuf message
MasterAuth
name (str) – The name (project, location, cluster) of the cluster to set auth. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, monitoring_service, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the monitoring service for a specific cluster.
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 `monitoring_service`: >>> monitoring_service = '' >>> >>> response = client.set_monitoring_service(project_id, zone, cluster_id, monitoring_service)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
monitoring_service (str) –
The monitoring service the cluster should use to write metrics. Currently available options:
”monitoring.googleapis.com” - the Google Cloud Monitoring service
”none” - no metrics will be exported from the cluster
name (str) – The name (project, location, cluster) of the cluster to set monitoring. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, network_policy, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Enables/Disables Network Policy for a cluster.
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 `network_policy`: >>> network_policy = {} >>> >>> response = client.set_network_policy(project_id, zone, cluster_id, network_policy)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
network_policy (Union[dict, NetworkPolicy]) –
Configuration options for the NetworkPolicy feature.
If a dict is provided, it must be of the same form as the protobuf message
NetworkPolicy
name (str) – The name (project, location, cluster id) of the cluster to set networking policy. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, autoscaling, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the autoscaling settings for a specific node pool.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> # TODO: Initialize `autoscaling`: >>> autoscaling = {} >>> >>> response = client.set_node_pool_autoscaling(project_id, zone, cluster_id, node_pool_id, autoscaling)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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.
autoscaling (Union[dict, NodePoolAutoscaling]) –
Autoscaling configuration for the node pool.
If a dict is provided, it must be of the same form as the protobuf message
NodePoolAutoscaling
name (str) – The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, management, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the NodeManagement options for a node pool.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> # TODO: Initialize `management`: >>> management = {} >>> >>> response = client.set_node_pool_management(project_id, zone, cluster_id, node_pool_id, management)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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.
management (Union[dict, NodeManagement]) –
NodeManagement configuration for the node pool.
If a dict is provided, it must be of the same form as the protobuf message
NodeManagement
name (str) – The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, node_count, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Sets the size for a specific node pool.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> # TODO: Initialize `node_count`: >>> node_count = 0 >>> >>> response = client.set_node_pool_size(project_id, zone, cluster_id, node_pool_id, node_count)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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.
node_count (int) – The desired node count for the pool.
name (str) – The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, name=None, rotate_credentials=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Start master IP rotation.
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 = '' >>> >>> response = client.start_i_p_rotation(project_id, zone, cluster_id)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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 ‘projects//locations//clusters/*’.
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
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, update, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Updates the settings of a specific cluster.
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 `update`: >>> update = {} >>> >>> response = client.update_cluster(project_id, zone, cluster_id, update)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
update (Union[dict, ClusterUpdate]) –
A description of the update.
If a dict is provided, it must be of the same form as the protobuf message
ClusterUpdate
name (str) – The name (project, location, cluster) of the cluster to update. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, master_version, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Updates the master for a specific cluster.
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 `master_version`: >>> master_version = '' >>> >>> response = client.update_master(project_id, zone, cluster_id, master_version)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (str) – Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
master_version (str) –
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
name (str) – The name (project, location, cluster) of the cluster to update. Specified in the format ‘projects//locations//clusters/*’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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
(project_id, zone, cluster_id, node_pool_id, node_version, image_type, name=None, retry=<object object>, timeout=<object object>, metadata=None)[source]# Updates the version and/or image type for a specific node pool.
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 `node_pool_id`: >>> node_pool_id = '' >>> >>> # TODO: Initialize `node_version`: >>> node_version = '' >>> >>> # TODO: Initialize `image_type`: >>> image_type = '' >>> >>> response = client.update_node_pool(project_id, zone, cluster_id, node_pool_id, node_version, image_type)
- Parameters
project_id (str) – Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.
zone (str) – 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 (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.
node_version (str) –
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) – The desired image type for the node pool.
name (str) – The name (project, location, cluster, node pool) of the node pool to update. Specified in the format ‘projects//locations//clusters//nodePools/’.
retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If
None
is specified, requests will not be retried.timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if
retry
is specified, the timeout applies to each individual attempt.metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.
- Returns
A
Operation
instance.- Raises
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.