jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	google.dataproc.jobs

Fields

Name	Datatype	Description
done	boolean	Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.
driverControlFilesUri	string	Output only. If present, the location of miscellaneous control files which can be used as part of job setup and handling. If not present, control files might be placed in the same location as driver_output_uri.
driverOutputResourceUri	string	Output only. A URI pointing to the location of the stdout of the job's driver program.
driverSchedulingConfig	object	Driver scheduling configuration.
flinkJob	object	A Dataproc job for running Apache Flink applications on YARN.
hadoopJob	object	A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).
hiveJob	object	A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.
jobUuid	string	Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time.
labels	object	Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
pigJob	object	A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.
placement	object	Dataproc job config.
prestoJob	object	A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster.
pysparkJob	object	A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.
reference	object	Encapsulates the full scoping used to reference a job.
scheduling	object	Job scheduling options.
sparkJob	object	A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN.
sparkRJob	object	A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN.
sparkSqlJob	object	A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries.
status	object	Dataproc job status.
statusHistory	array	Output only. The previous job status.
trinoJob	object	A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster.
yarnApplications	array	Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release.

Methods

Name	Accessible by	Required Params	Description
projects_regions_jobs_get	SELECT	jobId, projectId, region	Gets the resource representation for a job in a project.
projects_regions_jobs_list	SELECT	projectId, region	Lists regions/{region}/jobs in a project.
projects_regions_jobs_delete	DELETE	jobId, projectId, region	Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.
projects_regions_jobs_patch	UPDATE	jobId, projectId, region	Updates a job in a project.
projects_regions_jobs_cancel	EXEC	jobId, projectId, region	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).
projects_regions_jobs_submit	EXEC	projectId, region	Submits a job to a cluster.
projects_regions_jobs_submit_as_operation	EXEC	projectId, region	Submits job to a cluster.

SELECT examples

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

SELECT
done,
driverControlFilesUri,
driverOutputResourceUri,
driverSchedulingConfig,
flinkJob,
hadoopJob,
hiveJob,
jobUuid,
labels,
pigJob,
placement,
prestoJob,
pysparkJob,
reference,
scheduling,
sparkJob,
sparkRJob,
sparkSqlJob,
status,
statusHistory,
trinoJob,
yarnApplications
FROM google.dataproc.jobs
WHERE projectId = '{{ projectId }}'
AND region = '{{ region }}';

UPDATE example

Updates a jobs resource.

/*+ update */
UPDATE google.dataproc.jobs
SET 
reference = '{{ reference }}',
placement = '{{ placement }}',
hadoopJob = '{{ hadoopJob }}',
sparkJob = '{{ sparkJob }}',
pysparkJob = '{{ pysparkJob }}',
hiveJob = '{{ hiveJob }}',
pigJob = '{{ pigJob }}',
sparkRJob = '{{ sparkRJob }}',
sparkSqlJob = '{{ sparkSqlJob }}',
prestoJob = '{{ prestoJob }}',
trinoJob = '{{ trinoJob }}',
flinkJob = '{{ flinkJob }}',
labels = '{{ labels }}',
scheduling = '{{ scheduling }}',
driverSchedulingConfig = '{{ driverSchedulingConfig }}'
WHERE 
jobId = '{{ jobId }}'
AND projectId = '{{ projectId }}'
AND region = '{{ region }}';

DELETE example

Deletes the specified jobs resource.

/*+ delete */
DELETE FROM google.dataproc.jobs
WHERE jobId = '{{ jobId }}'
AND projectId = '{{ projectId }}'
AND region = '{{ region }}';