As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ClusterController

class google.cloud.dataproc_v1.services.cluster_controller.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/docs/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>)[source]

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

Instantiates the cluster controller client.

Parameters
  • 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.

Raises

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

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

Returns a fully-qualified cluster string.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Creates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation_async.AsyncOperation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
  • request (google.cloud.dataproc_v1.types.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

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 {}.

Return type

google.api_core.operation_async.AsyncOperation

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Gets cluster diagnostic information. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata. After the operation completes, [Operation.response][google.longrunning.Operation.response] contains DiagnoseClusterResults.

Parameters
  • request (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.DiagnoseClusterResults The location of diagnostic output.

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *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

ClusterControllerAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterControllerAsyncClient

classmethod from_service_account_json(filename: str, *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

ClusterControllerAsyncClient

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.clusters.Cluster[source]

Gets the resource representation for a cluster in a project.

Parameters
  • request (google.cloud.dataproc_v1.types.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

Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Return type

google.cloud.dataproc_v1.types.Cluster

get_transport_class()Type[google.cloud.dataproc_v1.services.cluster_controller.transports.base.ClusterControllerTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersAsyncPager[source]

Lists all regions/{region}/clusters in a project alphabetically.

Parameters
  • request (google.cloud.dataproc_v1.types.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

The list of all clusters in a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersAsyncPager

static parse_cluster_path(path: str)Dict[str, str]

Parses a cluster path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_service_path(path: str)Dict[str, str]

Parses a service path into its component segments.

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

Returns a fully-qualified service string.

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

Starts a cluster in a project.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation_async.AsyncOperation

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

Stops a cluster in a project.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.dataproc_v1.services.cluster_controller.transports.base.ClusterControllerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ClusterControllerTransport

async 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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:

    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_uriUse, 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.dataproc_v1.services.cluster_controller.ClusterControllerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataproc_v1.services.cluster_controller.transports.base.ClusterControllerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the cluster controller client.

Parameters
  • 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 (google.api_core.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.

  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

static cluster_path(project: str, location: str, cluster: str)str[source]

Returns a fully-qualified cluster string.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Creates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation.Operation

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Deletes a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
  • request (google.cloud.dataproc_v1.types.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

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 {}.

Return type

google.api_core.operation.Operation

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Gets cluster diagnostic information. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata. After the operation completes, [Operation.response][google.longrunning.Operation.response] contains DiagnoseClusterResults.

Parameters
  • request (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.DiagnoseClusterResults The location of diagnostic output.

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *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

ClusterControllerClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ClusterControllerClient

classmethod from_service_account_json(filename: str, *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

ClusterControllerClient

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.clusters.Cluster[source]

Gets the resource representation for a cluster in a project.

Parameters
  • request (google.cloud.dataproc_v1.types.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

Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Return type

google.cloud.dataproc_v1.types.Cluster

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersPager[source]

Lists all regions/{region}/clusters in a project alphabetically.

Parameters
  • request (google.cloud.dataproc_v1.types.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

The list of all clusters in a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersPager

static parse_cluster_path(path: str)Dict[str, str][source]

Parses a cluster path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_service_path(path: str)Dict[str, str][source]

Parses a service path into its component segments.

static service_path(project: str, location: str, service: str)str[source]

Returns a fully-qualified service string.

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

Starts a cluster in a project.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation.Operation

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

Stops a cluster in a project.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation.Operation

property transport: google.cloud.dataproc_v1.services.cluster_controller.transports.base.ClusterControllerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ClusterControllerTransport

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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
  • request (google.cloud.dataproc_v1.types.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 (google.cloud.dataproc_v1.types.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:

    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_uriUse, 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Cluster Describes the identifying information, config, and status of

a cluster of Compute Engine instances.

Return type

google.api_core.operation.Operation

class google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersAsyncPager(method: Callable[[...], Awaitable[google.cloud.dataproc_v1.types.clusters.ListClustersResponse]], request: google.cloud.dataproc_v1.types.clusters.ListClustersRequest, response: google.cloud.dataproc_v1.types.clusters.ListClustersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_clusters requests.

This class thinly wraps an initial google.cloud.dataproc_v1.types.ListClustersResponse object, and provides an __aiter__ method to iterate through its clusters field.

If there are more pages, the __aiter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual google.cloud.dataproc_v1.types.ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.dataproc_v1.services.cluster_controller.pagers.ListClustersPager(method: Callable[[...], google.cloud.dataproc_v1.types.clusters.ListClustersResponse], request: google.cloud.dataproc_v1.types.clusters.ListClustersRequest, response: google.cloud.dataproc_v1.types.clusters.ListClustersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_clusters requests.

This class thinly wraps an initial google.cloud.dataproc_v1.types.ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

If there are more pages, the __iter__ method will make additional ListClusters requests and continue to iterate through the clusters field on the corresponding responses.

All the usual google.cloud.dataproc_v1.types.ListClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters