- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists batch workloads.
HTTP request
GET https://dataproc.googleapis.com/v1/{parent=projects/*/locations/*}/batches
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent, which owns this collection of batches. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
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. |
pageToken |
Optional. A page token received from a previous |
filter |
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 e.g. See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons. |
orderBy |
Optional. Field(s) on which to sort the list of batches. Currently the only supported sort orders are unspecified (empty) and See https://google.aip.dev/132#ordering for more details. |
Request body
The request body must be empty.
Response body
A list of batch workloads.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"batches": [
{
object ( |
Fields | |
---|---|
batches[] |
Output only. The batches from the specified collection. |
nextPageToken |
A token, which can be sent as |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.