Class JobControllerAsyncClient (2.6.1)

JobControllerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport] = '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 JobController provides methods to manage jobs.

Inheritance

builtins.object > JobControllerAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
JobControllerTransport	The transport used by the client instance.

Methods

JobControllerAsyncClient

JobControllerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport] = '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 job 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, `.JobControllerTransport`] 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.

cancel_job

cancel_job(request: Optional[google.cloud.dataproc_v1.types.jobs.CancelJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list <https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list> or regions/{region}/jobs.get <https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get>.

Parameters

Name	Description
request	`CancelJobRequest` The request object. A request to cancel a job.
project_id	`str` Required. The ID of the Google Cloud Platform project that the job 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.
job_id	`str` Required. The job ID. This corresponds to the `job_id` 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.Job	A Dataproc job resource.

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.

delete_job

delete_job(request: Optional[google.cloud.dataproc_v1.types.jobs.DeleteJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: 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 job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters

Name	Description
request	`DeleteJobRequest` The request object. A request to delete a job.
project_id	`str` Required. The ID of the Google Cloud Platform project that the job 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.
job_id	`str` Required. The job ID. This corresponds to the `job_id` 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.

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
JobControllerAsyncClient	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
JobControllerAsyncClient	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
JobControllerAsyncClient	The constructed client.

get_job

get_job(request: Optional[google.cloud.dataproc_v1.types.jobs.GetJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: 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 job in a project.

Parameters

Name	Description
request	`GetJobRequest` The request object. A request to get the resource representation for a job in a project.
project_id	`str` Required. The ID of the Google Cloud Platform project that the job 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.
job_id	`str` Required. The job ID. This corresponds to the `job_id` 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.Job	A Dataproc job resource.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_jobs

list_jobs(request: Optional[google.cloud.dataproc_v1.types.jobs.ListJobsRequest] = 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 regions/{region}/jobs in a project.

Parameters

Name	Description
request	`ListJobsRequest` The request object. A request to list jobs in a project.
project_id	`str` Required. The ID of the Google Cloud Platform project that the job 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 jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where field is `status.state` or `labels.[KEY]`, and `[KEY]` is a label key. value can be `` to match all values. `status.state` can be either `ACTIVE` or `NON_ACTIVE`. Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator. Example filter: status.state = ACTIVE 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.job_controller.pagers.ListJobsAsyncPager	A list of jobs in a project. 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.

submit_job

submit_job(request: Optional[google.cloud.dataproc_v1.types.jobs.SubmitJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job: Optional[google.cloud.dataproc_v1.types.jobs.Job] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Submits a job to a cluster.

Parameters

Name	Description
request	`SubmitJobRequest` The request object. A request to submit a job.
project_id	`str` Required. The ID of the Google Cloud Platform project that the job 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.
job	`Job` Required. The job resource. This corresponds to the `job` 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.Job	A Dataproc job resource.

submit_job_as_operation

submit_job_as_operation(request: Optional[google.cloud.dataproc_v1.types.jobs.SubmitJobRequest] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job: Optional[google.cloud.dataproc_v1.types.jobs.Job] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Submits job to a cluster.

Parameters

Name	Description
request	`SubmitJobRequest` The request object. A request to submit a job.
project_id	`str` Required. The ID of the Google Cloud Platform project that the job 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.
job	`Job` Required. The job resource. This corresponds to the `job` 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 Job A Dataproc job resource.

update_job

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

Updates a job in a project.

Parameters

Name	Description
request	`UpdateJobRequest` The request object. A request to update a job.
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.Job	A Dataproc job resource.