Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.batchJobs

Resource: BatchJob

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.

JSON representation
{
  "resourceName": string,
  "metadata": {
    object (BatchJobMetadata)
  },
  "status": enum (BatchJobStatus),
  "id": string,
  "nextAddSequenceToken": string,
  "longRunningOperation": string
}
Fields
resourceName

string

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

customers/{customerId}/batchJobs/{batch_job_id}

metadata

object (BatchJobMetadata)

Output only. Contains additional information about this batch job.

status

enum (BatchJobStatus)

Output only. Status of this batch job.

id

string (int64 format)

Output only. ID of this batch job.

nextAddSequenceToken

string

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

longRunningOperation

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.

BatchJobMetadata

Additional information about the batch job. This message is also used as metadata returned in batch job Long Running Operations.

JSON representation
{
  "creationDateTime": string,
  "startDateTime": string,
  "completionDateTime": string,
  "estimatedCompletionRatio": number,
  "operationCount": string,
  "executedOperationCount": string
}
Fields
creationDateTime

string

Output only. The time when this batch job was created. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:00"

startDateTime

string

Output only. The time when this batch job started running. Formatted as yyyy-mm-dd hh:mm:ss. Example: "2018-03-05 09:15:30"

completionDateTime

string

Output only. The time when this batch job was completed. Formatted as yyyy-MM-dd HH:mm:ss. Example: "2018-03-05 09:16:00"

estimatedCompletionRatio

number

Output only. The fraction (between 0.0 and 1.0) of mutates that have been processed. This is empty if the job hasn't started running yet.

operationCount

string (int64 format)

Output only. The number of mutate operations in the batch job.

executedOperationCount

string (int64 format)

Output only. The number of mutate operations executed by the batch job. Present only if the job has started running.

BatchJobStatus

The batch job statuses.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PENDING The job is not currently running.
RUNNING The job is running.
DONE The job is done.

Methods

addOperations

Add operations to the batch job.

get

Returns the batch job.

listResults

Returns the results of the batch job.

mutate

Mutates a batch job.

run

Runs the batch job.