Method: projects.jobs.batchUpdate

Begins executing a batch update jobs operation.

HTTP request

POST https://jobs.googleapis.com/v4beta1/{parent=projects/*}/jobs:batchUpdate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the tenant under which the job is created.

The format is "projects/{project_id}/tenants/{tenantId}", for example, "projects/api-test-project/tenant/foo".

Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project".

Request body

The request body contains data with the following structure:

JSON representation
{
  "jobs": [
    {
      object (Job)
    }
  ],
  "updateMask": string
}
Fields
jobs[]

object (Job)

Required. The jobs to be updated.

updateMask

string (FieldMask format)

Optional but strongly recommended to be provided for the best service experience, also increase latency when checking status of batch operation.

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.

If updateMask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

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

Response body

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

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.

Try it!

Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Job search documentation
Trenger du hjelp? Gå til brukerstøttesiden vår.