Class ClusterControllerAsyncClient (2.6.1)

ClusterControllerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1.services.cluster_controller.transports.base.ClusterControllerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.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>)

The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

Inheritance

builtins.object > ClusterControllerAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
ClusterControllerTransport	The transport used by the client instance.

Methods

ClusterControllerAsyncClient

ClusterControllerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1.services.cluster_controller.transports.base.ClusterControllerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.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 controller client.

Parameters

Name	Description
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, `.ClusterControllerTransport`] 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

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

cluster_path

cluster_path(project: str, location: str, cluster: str)

Returns a fully-qualified cluster string.

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.

create_cluster

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

Creates a cluster in a project. The returned Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata>__.

Parameters

Name	Description
request	`CreateClusterRequest` The request object. A request to create a cluster.
project_id	`str` Required. The ID of the Google Cloud Platform project that the cluster belongs to. This corresponds to the `project_id` field on the `request` instance; if `request` is provided, this should not be set.
region	`str` Required. The Dataproc region in which to handle the request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
cluster	`Cluster` Required. The cluster to create. This corresponds to the `cluster` 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

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be Cluster Describes the identifying information, config, and status of a cluster of Compute Engine instances.

delete_cluster

delete_cluster(request: Optional[google.cloud.dataproc_v1.types.clusters.DeleteClusterRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, cluster_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 cluster in a project. The returned Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata>__.

Parameters

Name	Description
request	`DeleteClusterRequest` The request object. A request to delete a cluster.
project_id	`str` Required. The ID of the Google Cloud Platform project that the cluster belongs to. This corresponds to the `project_id` field on the `request` instance; if `request` is provided, this should not be set.
region	`str` Required. The Dataproc region in which to handle the request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
cluster_name	`str` Required. The cluster name. This corresponds to the `cluster_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

Type

Description

google.api_core.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

diagnose_cluster

diagnose_cluster(request: Optional[google.cloud.dataproc_v1.types.clusters.DiagnoseClusterRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, cluster_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 cluster diagnostic information. The returned Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata>. After the operation completes, Operation.response][google.longrunning.Operation.response] contains DiagnoseClusterResults <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults>.

Parameters

Name	Description
request	`DiagnoseClusterRequest` The request object. A request to collect cluster diagnostic information.
project_id	`str` Required. The ID of the Google Cloud Platform project that the cluster belongs to. This corresponds to the `project_id` field on the `request` instance; if `request` is provided, this should not be set.
region	`str` Required. The Dataproc region in which to handle the request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
cluster_name	`str` Required. The cluster name. This corresponds to the `cluster_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

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be DiagnoseClusterResults The location of diagnostic output.

from_service_account_file

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

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

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
ClusterControllerAsyncClient	The 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

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
ClusterControllerAsyncClient	The 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

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
ClusterControllerAsyncClient	The constructed client.

get_cluster

get_cluster(request: Optional[google.cloud.dataproc_v1.types.clusters.GetClusterRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, cluster_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 resource representation for a cluster in a project.

Parameters

Name	Description
request	`GetClusterRequest` The request object. Request to get the resource representation for a cluster in a project.
project_id	`str` Required. The ID of the Google Cloud Platform project that the cluster belongs to. This corresponds to the `project_id` field on the `request` instance; if `request` is provided, this should not be set.
region	`str` Required. The Dataproc region in which to handle the request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
cluster_name	`str` Required. The cluster name. This corresponds to the `cluster_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

Type	Description
google.cloud.dataproc_v1.types.Cluster	Describes the identifying information, config, and status of a cluster of Compute Engine instances.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_clusters

list_clusters(request: Optional[google.cloud.dataproc_v1.types.clusters.ListClustersRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, filter: 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 regions/{region}/clusters in a project alphabetically.

Parameters

Name	Description
request	`ListClustersRequest` The request object. A request to list the clusters in a project.
project_id	`str` Required. The ID of the Google Cloud Platform project that the cluster belongs to. This corresponds to the `project_id` field on the `request` instance; if `request` is provided, this should not be set.
region	`str` Required. The Dataproc region in which to handle the request. This corresponds to the `region` field on the `request` instance; if `request` is provided, this should not be set.
filter	`str` Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] ... where field is one of `status.state`, `clusterName`, or `labels.[KEY]`, and `[KEY]` is a label key. value can be `` to match all values. `status.state` can be one of the following: `ACTIVE`, `INACTIVE`, `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE` contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE` contains the `DELETING` and `ERROR` states. `clusterName` is the name of the cluster provided at creation time. Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator. Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = This corresponds to the `filter` 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

Type	Description
google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersAsyncPager	The list of all clusters in a project. Iterating over this object will yield results and resolve additional pages automatically.

parse_cluster_path

parse_cluster_path(path: str)

Parses a cluster path into its component segments.

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.

parse_service_path

parse_service_path(path: str)

Parses a service path into its component segments.

service_path

service_path(project: str, location: str, service: str)

Returns a fully-qualified service string.

start_cluster

start_cluster(request: Optional[google.cloud.dataproc_v1.types.clusters.StartClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts a cluster in a project.

Parameters

Name	Description
request	`StartClusterRequest` The request object. A request to start a 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

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be Cluster Describes the identifying information, config, and status of a cluster of Compute Engine instances.

stop_cluster

stop_cluster(request: Optional[google.cloud.dataproc_v1.types.clusters.StopClusterRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Stops a cluster in a project.

Parameters

Name	Description
request	`StopClusterRequest` The request object. A request to stop a 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

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be Cluster Describes the identifying information, config, and status of a cluster of Compute Engine instances.

update_cluster

update_cluster(request: Optional[google.cloud.dataproc_v1.types.clusters.UpdateClusterRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, cluster_name: Optional[str] = None, cluster: Optional[google.cloud.dataproc_v1.types.clusters.Cluster] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a cluster in a project. The returned Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata <https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata>__.

Parameters

Name Description

request

UpdateClusterRequest

The request object. A request to update a cluster.

project_id

`str`

Required. The ID of the Google Cloud Platform project the cluster belongs to. This corresponds to the project_id field on the request instance; if request is provided, this should not be set.

region

`str`

Required. The Dataproc region in which to handle the request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

cluster_name

`str`

Required. The cluster name. This corresponds to the cluster_name field on the request instance; if request is provided, this should not be set.

cluster

Cluster

Required. The changes to the cluster. This corresponds to the cluster field on the request instance; if request is provided, this should not be set.

update_mask

`google.protobuf.field_mask_pb2.FieldMask`

Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: :: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: :: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated: .. raw:: html

Mask	Purpose
*labels*	Update labels
*config.worker_config.num_instances*	Resize primary worker group
*config.secondary_worker_config.num_instances*	Resize secondary worker group
config.autoscaling_config.policy_uri	Use, stop using, or change autoscaling policies

This corresponds to the update_mask 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

Type	Description
google.api_core.operation_async.AsyncOperation	An object representing a long-running operation. The result type for the operation will be Cluster Describes the identifying information, config, and status of a cluster of Compute Engine instances.