Method: projects.locations.jobs.patch

Updates a job.

If successful, the updated Job is returned. If the job does not exist, NOT_FOUND is returned.

If jobs.patch does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the jobs.patch request until a successful response is received.

HTTP request

PATCH https://cloudscheduler.googleapis.com/v1/{job.name=projects/*/locations/*/jobs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
job.name

string

Optionally caller-specified in jobs.create , after which it becomes output only.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID .

  • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is the canonical ID for the job's location. The list of available locations can be obtained by calling locations.list . For more information, see https://cloud.google.com/about/locations/ .
  • JOB_ID can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.

Query parameters

Parameters
updateMask

string ( FieldMask format)

A mask used to specify which fields of the job are being updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .

Request body

The request body contains an instance of Job .

Response body

If successful, the response body contains an instance of Job .

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-scheduler

For more information, see the Authentication Overview .

Design a Mobile Site
View Site in Mobile | Classic
Share by: