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 \ V1Methods
__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 |
↳ 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 |
↳ order_by |
string
Optional. Field(s) on which to sort the list of batches. Currently the only supported sort orders are unspecified (empty) and |
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 BatchControllerClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListBatchesRequest |
|