Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1362267343.4 KB
projects

Creates a batch workload that executes asynchronously.

post/v1/{+parent}/batches

Path parameters

parentstring required

Required. The parent resource where this batch will be created.

Query parameters

batchIdstring

Optional. The ID to use for the batch, which will become the final component of the batch's resource name.This value must be 4-63 characters. Valid characters are /[a-z][0-9]-/.

requestIdstring

Optional. A unique ID used to identify the request. If the service receives two CreateBatchRequests with the same request_id, the second request is ignored and the operation that corresponds to the first Batch created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Request body

state'STATE_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'SUCCEEDED' | 'FAILED'

Output only. The state of the batch.

createTimestring google-datetime

Output only. The time when the batch was created.

namestring

Output only. The resource name of the batch.

uuidstring

Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.

labelsobject

Optional. The labels to associate with this batch. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a batch.

operationstring

Output only. The resource name of the operation associated with this batch.

stateMessagestring

Output only. Batch state details, such as a failure description if the state is FAILED.

stateTimestring google-datetime

Output only. The time when the batch entered a current state.

creatorstring

Output only. The email address of the user who created the batch.

Response

Successful response