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.

JobController

class google.cloud.dataproc_v1.services.job_controller.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/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 JobController provides methods to manage jobs.

Instantiates the job 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, 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.

Raises

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

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

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

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

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

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

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

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

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

JobControllerAsyncClient

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

JobControllerAsyncClient

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

JobControllerAsyncClient

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

Gets the resource representation for a job in a project.

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

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

get_transport_class()Type[google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport]

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

Lists regions/{region}/jobs in a project.

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

A list of jobs in a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsAsyncPager

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.

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

Submits a job to a cluster.

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

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

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

Submits job to a cluster.

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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Job A Dataproc job resource.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

JobControllerTransport

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

Updates a job in a project.

Parameters
Returns

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

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

Instantiates the job 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, JobControllerTransport]) – 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.

cancel_job(request: Optional[Union[google.cloud.dataproc_v1.types.jobs.CancelJobRequest, dict]] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: 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.jobs.Job[source]

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Parameters
  • request (Union[google.cloud.dataproc_v1.types.CancelJobRequest, dict]) – 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

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

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.

delete_job(request: Optional[Union[google.cloud.dataproc_v1.types.jobs.DeleteJobRequest, dict]] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters
  • request (Union[google.cloud.dataproc_v1.types.DeleteJobRequest, dict]) – 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.

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

JobControllerClient

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

JobControllerClient

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

JobControllerClient

get_job(request: Optional[Union[google.cloud.dataproc_v1.types.jobs.GetJobRequest, dict]] = None, *, project_id: Optional[str] = None, region: Optional[str] = None, job_id: 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.jobs.Job[source]

Gets the resource representation for a job in a project.

Parameters
  • request (Union[google.cloud.dataproc_v1.types.GetJobRequest, dict]) – 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

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

list_jobs(request: Optional[Union[google.cloud.dataproc_v1.types.jobs.ListJobsRequest, dict]] = 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.job_controller.pagers.ListJobsPager[source]

Lists regions/{region}/jobs in a project.

Parameters
  • request (Union[google.cloud.dataproc_v1.types.ListJobsRequest, dict]) – 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

A list of jobs in a project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsPager

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.

submit_job(request: Optional[Union[google.cloud.dataproc_v1.types.jobs.SubmitJobRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.dataproc_v1.types.jobs.Job[source]

Submits a job to a cluster.

Parameters
  • request (Union[google.cloud.dataproc_v1.types.SubmitJobRequest, dict]) – 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 (google.cloud.dataproc_v1.types.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

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

submit_job_as_operation(request: Optional[Union[google.cloud.dataproc_v1.types.jobs.SubmitJobRequest, dict]] = 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 = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Submits job to a cluster.

Parameters
  • request (Union[google.cloud.dataproc_v1.types.SubmitJobRequest, dict]) – 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 (google.cloud.dataproc_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.dataproc_v1.types.Job A Dataproc job resource.

Return type

google.api_core.operation.Operation

property transport: google.cloud.dataproc_v1.services.job_controller.transports.base.JobControllerTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

JobControllerTransport

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

Updates a job in a project.

Parameters
Returns

A Dataproc job resource.

Return type

google.cloud.dataproc_v1.types.Job

class google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsAsyncPager(method: Callable[[...], Awaitable[google.cloud.dataproc_v1.types.jobs.ListJobsResponse]], request: google.cloud.dataproc_v1.types.jobs.ListJobsRequest, response: google.cloud.dataproc_v1.types.jobs.ListJobsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_jobs requests.

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

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

All the usual google.cloud.dataproc_v1.types.ListJobsResponse 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.job_controller.pagers.ListJobsPager(method: Callable[[...], google.cloud.dataproc_v1.types.jobs.ListJobsResponse], request: google.cloud.dataproc_v1.types.jobs.ListJobsRequest, response: google.cloud.dataproc_v1.types.jobs.ListJobsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_jobs requests.

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

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

All the usual google.cloud.dataproc_v1.types.ListJobsResponse 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