Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListBatchesRequest.
A request to list batch workloads in a project.
Generated from protobuf message google.cloud.dataproc.v1.ListBatchesRequest
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
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
string
Optional. A page token received from a previous ListBatches call. Provide this token to retrieve the subsequent page.
↳ filter
string
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 < "2023-01-01T00:00:00Z" 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
string
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.
getParent
Required. The parent, which owns this collection of batches.
Returns
Type
Description
string
setParent
Required. The parent, which owns this collection of batches.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
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.
Returns
Type
Description
int
setPageSize
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token received from a previous ListBatches call.
Provide this token to retrieve the subsequent page.
Returns
Type
Description
string
setPageToken
Optional. A page token received from a previous ListBatches call.
Provide this token to retrieve the subsequent page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
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 < "2023-01-01T00:00:00Z"
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.
Returns
Type
Description
string
setFilter
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 < "2023-01-01T00:00:00Z"
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
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.
Returns
Type
Description
string
setOrderBy
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent, which owns this collection of batches. Please see
Google\Cloud\Dataproc\V1\BatchControllerClient::locationName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataproc V1 Client - Class ListBatchesRequest (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.ListBatchesRequest)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.ListBatchesRequest)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.ListBatchesRequest)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.ListBatchesRequest)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.ListBatchesRequest)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.ListBatchesRequest)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.ListBatchesRequest)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.ListBatchesRequest)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.ListBatchesRequest)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.ListBatchesRequest)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.ListBatchesRequest)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.ListBatchesRequest)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.ListBatchesRequest)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.ListBatchesRequest)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.ListBatchesRequest)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.ListBatchesRequest)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.ListBatchesRequest)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.ListBatchesRequest)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.ListBatchesRequest) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class ListBatchesRequest.\n\nA request to list batch workloads in a project.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.ListBatchesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent, which owns this collection of batches.\n\n### setParent\n\nRequired. The parent, which owns this collection of batches.\n\n### getPageSize\n\nOptional. The maximum number of batches to return in each response.\n\nThe service may return fewer than this value.\nThe default page size is 20; the maximum page size is 1000.\n\n### setPageSize\n\nOptional. The maximum number of batches to return in each response.\n\nThe service may return fewer than this value.\nThe default page size is 20; the maximum page size is 1000.\n\n### getPageToken\n\nOptional. A page token received from a previous `ListBatches` call.\n\nProvide this token to retrieve the subsequent page.\n\n### setPageToken\n\nOptional. A page token received from a previous `ListBatches` call.\n\nProvide this token to retrieve the subsequent page.\n\n### getFilter\n\nOptional. A filter for the batches to return in the response.\n\nA filter is a logical expression constraining the values of various fields\nin each batch resource. Filters are case sensitive, and may contain\nmultiple clauses combined with logical operators (AND/OR).\nSupported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.\ne.g. `state = RUNNING and create_time \u003c \"2023-01-01T00:00:00Z\"`\nfilters for batches in state RUNNING that were created before 2023-01-01\nSee \u003chttps://google.aip.dev/assets/misc/ebnf-filtering.txt\u003e for a detailed\ndescription of the filter syntax and a list of supported comparisons.\n\n### setFilter\n\nOptional. A filter for the batches to return in the response.\n\nA filter is a logical expression constraining the values of various fields\nin each batch resource. Filters are case sensitive, and may contain\nmultiple clauses combined with logical operators (AND/OR).\nSupported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`.\ne.g. `state = RUNNING and create_time \u003c \"2023-01-01T00:00:00Z\"`\nfilters for batches in state RUNNING that were created before 2023-01-01\nSee \u003chttps://google.aip.dev/assets/misc/ebnf-filtering.txt\u003e for a detailed\ndescription of the filter syntax and a list of supported comparisons.\n\n### getOrderBy\n\nOptional. Field(s) on which to sort the list of batches.\n\nCurrently the only supported sort orders are unspecified (empty) and\n`create_time desc` to sort by most recently created batches first.\nSee \u003chttps://google.aip.dev/132#ordering\u003e for more details.\n\n### setOrderBy\n\nOptional. Field(s) on which to sort the list of batches.\n\nCurrently the only supported sort orders are unspecified (empty) and\n`create_time desc` to sort by most recently created batches first.\nSee \u003chttps://google.aip.dev/132#ordering\u003e for more details.\n\n### static::build"]]
