Class ClusterManagerAsyncClient (2.6.1)

Stay organized with collections Save and categorize content based on your preferences.
ClusterManagerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.container_v1.services.cluster_manager.transports.base.ClusterManagerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-container/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Google Kubernetes Engine Cluster Manager v1

Inheritance

builtins.object > ClusterManagerAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
ClusterManagerTransportThe transport used by the client instance.

Methods

ClusterManagerAsyncClient

ClusterManagerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.container_v1.services.cluster_manager.transports.base.ClusterManagerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-container/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the cluster manager client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, `.ClusterManagerTransport`]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

cancel_operation

cancel_operation(request: Optional[google.cloud.container_v1.types.cluster_service.CancelOperationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Cancels the specified operation.

Parameters
NameDescription
request CancelOperationRequest

The request object. CancelOperationRequest cancels a single operation.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the operation resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

operation_id `str`

Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field. This corresponds to the operation_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, operation id) of the operation to cancel. Specified in the format projects/*/locations/*/operations/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

complete_ip_rotation

complete_ip_rotation(request: Optional[google.cloud.container_v1.types.cluster_service.CompleteIPRotationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Completes master IP rotation.

Parameters
NameDescription
request CompleteIPRotationRequest

The request object. CompleteIPRotationRequest moves the cluster master back into single-IP mode.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://developers.google.com/console/help/new/#projectnumber>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster id) of the cluster to complete IP rotation. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

create_cluster

create_cluster(request: Optional[google.cloud.container_v1.types.cluster_service.CreateClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster: Optional[google.cloud.container_v1.types.cluster_service.Cluster] = None, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
NameDescription
request CreateClusterRequest

The request object. CreateClusterRequest creates a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the parent field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the parent field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster Cluster

Required. A cluster resource <https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters>__ This corresponds to the cluster field on the request instance; if request is provided, this should not be set.

parent `str`

The parent (project and location) where the cluster will be created. Specified in the format projects/*/locations/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

create_node_pool

create_node_pool(request: Optional[google.cloud.container_v1.types.cluster_service.CreateNodePoolRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool: Optional[google.cloud.container_v1.types.cluster_service.NodePool] = None, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a node pool for a cluster.

Parameters
NameDescription
request CreateNodePoolRequest

The request object. CreateNodePoolRequest creates a node pool for a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://developers.google.com/console/help/new/#projectnumber>__. This field has been deprecated and replaced by the parent field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the parent field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

node_pool NodePool

Required. The node pool to create. This corresponds to the node_pool field on the request instance; if request is provided, this should not be set.

parent `str`

The parent (project, location, cluster id) where the node pool will be created. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

delete_cluster

delete_cluster(request: Optional[google.cloud.container_v1.types.cluster_service.DeleteClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
NameDescription
request DeleteClusterRequest

The request object. DeleteClusterRequest deletes a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster) of the cluster to delete. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

delete_node_pool

delete_node_pool(request: Optional[google.cloud.container_v1.types.cluster_service.DeleteNodePoolRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a node pool from a cluster.

Parameters
NameDescription
request DeleteNodePoolRequest

The request object. DeleteNodePoolRequest deletes a node pool for a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://developers.google.com/console/help/new/#projectnumber>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

node_pool_id `str`

Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. This corresponds to the node_pool_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format projects/*/locations/*/clusters/*/nodePools/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ClusterManagerAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
ClusterManagerAsyncClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ClusterManagerAsyncClientThe constructed client.

get_cluster

get_cluster(request: Optional[google.cloud.container_v1.types.cluster_service.GetClusterRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the details of a specific cluster.

Parameters
NameDescription
request GetClusterRequest

The request object. GetClusterRequest gets the settings of a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.ClusterA Google Kubernetes Engine cluster.

get_json_web_keys

get_json_web_keys(request: Optional[google.cloud.container_v1.types.cluster_service.GetJSONWebKeysRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all clusters.

Parameters
NameDescription
request GetJSONWebKeysRequest

The request object. GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.GetJSONWebKeysResponseGetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517

get_node_pool

get_node_pool(request: Optional[google.cloud.container_v1.types.cluster_service.GetNodePoolRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the requested node pool.

Parameters
NameDescription
request GetNodePoolRequest

The request object. GetNodePoolRequest retrieves a node pool for a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://developers.google.com/console/help/new/#projectnumber>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

node_pool_id `str`

Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. This corresponds to the node_pool_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format projects/*/locations/*/clusters/*/nodePools/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.NodePoolNodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

get_operation

get_operation(request: Optional[google.cloud.container_v1.types.cluster_service.GetOperationRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, operation_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the specified operation.

Parameters
NameDescription
request GetOperationRequest

The request object. GetOperationRequest gets a single operation.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

operation_id `str`

Deprecated. The server-assigned name of the operation. This field has been deprecated and replaced by the name field. This corresponds to the operation_id field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, operation id) of the operation to get. Specified in the format projects/*/locations/*/operations/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

get_server_config

get_server_config(request: Optional[google.cloud.container_v1.types.cluster_service.GetServerConfigRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns configuration info about the Google Kubernetes Engine service.

Parameters
NameDescription
request GetServerConfigRequest

The request object. Gets the current Kubernetes Engine service configuration.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ to return operations for. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

name `str`

The name (project and location) of the server config to get, specified in the format projects/*/locations/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.ServerConfigKubernetes Engine service configuration.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_clusters

list_clusters(request: Optional[google.cloud.container_v1.types.cluster_service.ListClustersRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all clusters owned by a project in either the specified zone or all zones.

Parameters
NameDescription
request ListClustersRequest

The request object. ListClustersRequest lists clusters.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the parent field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

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. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.ListClustersResponseListClustersResponse is the result of ListClustersRequest.

list_node_pools

list_node_pools(request: Optional[google.cloud.container_v1.types.cluster_service.ListNodePoolsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the node pools for a cluster.

Parameters
NameDescription
request ListNodePoolsRequest

The request object. ListNodePoolsRequest lists the node pool(s) for a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://developers.google.com/console/help/new/#projectnumber>__. This field has been deprecated and replaced by the parent field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the parent field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

parent `str`

The parent (project, location, cluster id) where the node pools will be listed. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.ListNodePoolsResponseListNodePoolsResponse is the result of ListNodePoolsRequest.

list_operations

list_operations(request: Optional[google.cloud.container_v1.types.cluster_service.ListOperationsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all operations in a project in a specific zone or all zones.

Parameters
NameDescription
request ListOperationsRequest

The request object. ListOperationsRequest lists operations.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the parent field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ to return operations for, or - for all zones. This field has been deprecated and replaced by the parent field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.ListOperationsResponseListOperationsResponse is the result of ListOperationsRequest.

list_usable_subnetworks

list_usable_subnetworks(request: Optional[google.cloud.container_v1.types.cluster_service.ListUsableSubnetworksRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists subnetworks that are usable for creating clusters in a project.

Parameters
NameDescription
request ListUsableSubnetworksRequest

The request object. ListUsableSubnetworksRequest requests the list of usable subnetworks available to a user for creating clusters.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.services.cluster_manager.pagers.ListUsableSubnetworksAsyncPagerListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

rollback_node_pool_upgrade

rollback_node_pool_upgrade(request: Optional[google.cloud.container_v1.types.cluster_service.RollbackNodePoolUpgradeRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, node_pool_id: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

Parameters
NameDescription
request RollbackNodePoolUpgradeRequest

The request object. RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

node_pool_id `str`

Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. This corresponds to the node_pool_id field on the request instance; if request is provided, this should not be set.

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/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

set_addons_config

set_addons_config(request: Optional[google.cloud.container_v1.types.cluster_service.SetAddonsConfigRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, addons_config: Optional[google.cloud.container_v1.types.cluster_service.AddonsConfig] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the addons for a specific cluster.

Parameters
NameDescription
request SetAddonsConfigRequest

The request object. SetAddonsConfigRequest sets the addons associated with the cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

addons_config AddonsConfig

Required. The desired configurations for the various addons available to run in the cluster. This corresponds to the addons_config field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster) of the cluster to set addons. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

set_labels

set_labels(request: Optional[google.cloud.container_v1.types.cluster_service.SetLabelsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets labels on a cluster.

Parameters
NameDescription
request SetLabelsRequest

The request object. SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

set_legacy_abac

set_legacy_abac(request: Optional[google.cloud.container_v1.types.cluster_service.SetLegacyAbacRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, enabled: Optional[bool] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Enables or disables the ABAC authorization mechanism on a cluster.

Parameters
NameDescription
request SetLegacyAbacRequest

The request object. SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

enabled `bool`

Required. Whether ABAC authorization will be enabled in the cluster. This corresponds to the enabled field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster id) of the cluster to set legacy abac. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

set_locations

set_locations(request: Optional[google.cloud.container_v1.types.cluster_service.SetLocationsRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, locations: Optional[Sequence[str]] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update <https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update>__ instead.

Parameters
NameDescription
request SetLocationsRequest

The request object. SetLocationsRequest sets the locations of the cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

locations :class:`Sequence[str]`

Required. The desired list of Google Compute Engine zones <https://cloud.google.com/compute/docs/zones#available>__ 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. This corresponds to the locations field on the request instance; if request is provided, this should not be set.

name `str`

The name (project, location, cluster) of the cluster to set locations. Specified in the format projects/*/locations/*/clusters/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.container_v1.types.OperationThis operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

set_logging_service

set_logging_service(request: Optional[google.cloud.container_v1.types.cluster_service.SetLoggingServiceRequest] = None, *, project_id: Optional[str] = None, zone: Optional[str] = None, cluster_id: Optional[str] = None, logging_service: Optional[str] = None, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the logging service for a specific cluster.

Parameters
NameDescription
request SetLoggingServiceRequest

The request object. SetLoggingServiceRequest sets the logging service of a cluster.

project_id `str`

Deprecated. The Google Developers Console project ID or project number <https://support.google.com/cloud/answer/6158840>__. This field has been deprecated and replaced by the name field. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

zone `str`

Deprecated. The name of the Google Compute Engine zone <https://cloud.google.com/compute/docs/zones#available>__ in which the cluster resides. This field has been deprecated and replaced by the name field. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

cluster_id `str`

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. This corresponds to the cluster_id field on the request instance; if request is provided, this should not be set.

logging_service `str`

Required. The logging service the cluster should use to write logs. Currently available options: - logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model - logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). - none - no logs will be exported from the cluster. If left as an empty string,\ logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions. This corresponds to the logging_service field on the request instance; if