Class JobControllerClient (4.0.3)

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>)

The JobController provides methods to manage jobs.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
JobControllerTransportThe transport used by the client instance.

Methods

JobControllerClient

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>)

Instantiates the job controller client.

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

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

transport Union[str, 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.

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

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_job

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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>.

from google.cloud import dataproc_v1

def sample_cancel_job():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    request = dataproc_v1.CancelJobRequest(
        project_id="project_id_value",
        region="region_value",
        job_id="job_id_value",
    )

    # Make the request
    response = client.cancel_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.dataproc_v1.types.JobA 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[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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.

from google.cloud import dataproc_v1

def sample_delete_job():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    request = dataproc_v1.DeleteJobRequest(
        project_id="project_id_value",
        region="region_value",
        job_id="job_id_value",
    )

    # Make the request
    client.delete_job(request=request)
Parameters
NameDescription
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.

from_service_account_file

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
JobControllerClientThe constructed client.

from_service_account_info

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

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

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
JobControllerClientThe constructed client.

from_service_account_json

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
JobControllerClientThe constructed client.

get_job

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the resource representation for a job in a project.

from google.cloud import dataproc_v1

def sample_get_job():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    request = dataproc_v1.GetJobRequest(
        project_id="project_id_value",
        region="region_value",
        job_id="job_id_value",
    )

    # Make the request
    response = client.get_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.dataproc_v1.types.JobA Dataproc job resource.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

list_jobs

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import dataproc_v1

def sample_list_jobs():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    request = dataproc_v1.ListJobsRequest(
        project_id="project_id_value",
        region="region_value",
    )

    # Make the request
    page_result = client.list_jobs(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.dataproc_v1.services.job_controller.pagers.ListJobsPagerA 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[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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Submits a job to a cluster.

from google.cloud import dataproc_v1

def sample_submit_job():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    job = dataproc_v1.Job()
    job.hadoop_job.main_jar_file_uri = "main_jar_file_uri_value"
    job.placement.cluster_name = "cluster_name_value"

    request = dataproc_v1.SubmitJobRequest(
        project_id="project_id_value",
        region="region_value",
        job=job,
    )

    # Make the request
    response = client.submit_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.dataproc_v1.types.JobA Dataproc job resource.

submit_job_as_operation

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Submits job to a cluster.

from google.cloud import dataproc_v1

def sample_submit_job_as_operation():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    job = dataproc_v1.Job()
    job.hadoop_job.main_jar_file_uri = "main_jar_file_uri_value"
    job.placement.cluster_name = "cluster_name_value"

    request = dataproc_v1.SubmitJobRequest(
        project_id="project_id_value",
        region="region_value",
        job=job,
    )

    # Make the request
    operation = client.submit_job_as_operation(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.api_core.operation.OperationAn 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[Union[google.cloud.dataproc_v1.types.jobs.UpdateJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a job in a project.

from google.cloud import dataproc_v1

def sample_update_job():
    # Create a client
    client = dataproc_v1.JobControllerClient()

    # Initialize request argument(s)
    job = dataproc_v1.Job()
    job.hadoop_job.main_jar_file_uri = "main_jar_file_uri_value"
    job.placement.cluster_name = "cluster_name_value"

    request = dataproc_v1.UpdateJobRequest(
        project_id="project_id_value",
        region="region_value",
        job_id="job_id_value",
        job=job,
    )

    # Make the request
    response = client.update_job(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.dataproc_v1.types.UpdateJobRequest, dict]

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
TypeDescription
google.cloud.dataproc_v1.types.JobA Dataproc job resource.