BatchJob

  • Batch jobs process user-uploaded mutates asynchronously.

  • The mutates themselves are not readable, and results require using BatchJobService.ListBatchJobResults.

  • Key fields include resource_name, metadata, status, id, next_add_sequence_token, and long_running_operation.

  • The status field indicates the current state of the batch job.

  • The long_running_operation field provides the resource name to check for job completion when the status is RUNNING or DONE.

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.

Fields

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}

metadata

BatchJobMetadata

Output only. Contains additional information about this batch job.

status

BatchJobStatus

Output only. Status of this batch job.

id

int64

Output only. ID of 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.

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.