v1

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

Lists batch workloads.

get/v1/{+parent}/batches

Path parameters

parentstring required

Required. The parent, which owns this collection of batches.

Query parameters

filterstring

Optional. A filter for the batches to return in the response.A filter is a logical expression constraining the values of various fields in each batch resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields: * batch_id * batch_uuid * state * create_time * labels * runtime_info.cohort_info.cohort e.g. state = RUNNING and create_time < "2023-01-01T00:00:00Z" filters for batches in state RUNNING that were created before 2023-01-01. state = RUNNING and labels.environment=production filters for batches in state in a RUNNING state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.

orderBystring

Optional. Field(s) on which to sort the list of batches.Currently the only supported sort orders are unspecified (empty) and create_time desc to sort by most recently created batches first.See https://google.aip.dev/132#ordering for more details.

pageSizeinteger

Optional. The maximum number of batches to return in each response. The service may return fewer than this value. The default page size is 20; the maximum page size is 1000.

pageTokenstring

Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.

Response

Successful response