projects

PATCH /v1/projects/{projectId}/regions/{region}/jobs/{jobId}

Changed on Oct 29, 2026

Updates a job in a project.

Request

Base URL
https://dataproc.googleapis.com
Auth
- OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/cloud-platform
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/cloud-platform
- or OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/dataproc
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/dataproc
TypeScript
https://skmtc.dev/google/apis/dataproc/docs/v1/projects/:projectId/regions/:region/jobs/:jobId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

Required. The ID of the Google Cloud Platform project that the job belongs to.

regionstring required

Required. The Dataproc region in which to handle the request.

jobIdstring required

Required. The job ID.

Query parameters

updateMaskstring google-fieldmask

Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. Note: Currently, labels is the only field that can be updated.

Request body

doneboolean

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.

driverControlFilesUristring

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.

driverOutputResourceUristring

Output only. A URI pointing to the location of the stdout of the job's driver program.

jobUuidstring

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.

labelsobject

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.

Response

Successful response