Class ListBatchesRequest (5.9.3)

ListBatchesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A request to list batch workloads in a project.

Attributes

NameDescription
parent str
Required. The parent, which owns this collection of batches.
page_size int
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.
page_token str
Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
filter str
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 are batch_id, batch_uuid, state, and create_time. e.g. state = RUNNING and create_time <> filters for batches in state RUNNING that were created before 2023-01-01 See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.
order_by str
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.