BatchJob

  • Batch jobs process user-uploaded mutates asynchronously.

  • The mutates themselves are not readable, and results are accessed via BatchJobService.ListBatchJobResults.

  • Batch jobs have properties like resource name, metadata, status, ID, next add sequence token, and a long-running operation resource name.

A list of mutates being processed asynchronously. The mutates are uploaded by the user. The mutates themselves aren't readable and the results of the job can only be read using BatchJobService.ListBatchJobResults.

Proto definition GitHub

Fields

id

int64

Output only. ID of this batch job.

long_running_operation

string

Output only. The resource name of the long-running operation that can be used to poll for completion. Only set when the batch job status is RUNNING or DONE.

metadata

BatchJobMetadata

Output only. Contains additional information about this batch job.

next_add_sequence_token

string

Output only. The next sequence token to use when adding operations. Only set when the batch job status is PENDING.

resource_name

string

Immutable. The resource name of the batch job. Batch job resource names have the form:

customers/{customer_id}/batchJobs/{batch_job_id}

status

BatchJobStatus

Output only. Status of this batch job.