Method: projects.tenants.jobs.patch

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

HTTP request

PATCH https://jobs.googleapis.com/v4/{job.name=projects/*/tenants/*/jobs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
job.name

string

Required during job update.

The resource name for the job. This is generated by the service when a job is created.

The format is "projects/{projectId}/tenants/{tenantId}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

Use of this field in job queries and API calls is preferred over the use of requisitionId since this value is unique.

Query parameters

Parameters
updateMask

string (FieldMask format)

Strongly recommended for the best service experience.

If updateMask is provided, only the specified fields in job are updated. Otherwise all the fields are updated.

A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

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/jobs
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.