Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListClustersRequest.
A request to list the clusters in a project.
Generated from protobuf message google.cloud.dataproc.v1.ListClustersRequest
Namespace
Google \ Cloud \ Dataproc \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ project_id
string
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
↳ region
string
Required. The Dataproc region in which to handle the request.
↳ filter
string
Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] ... where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator. Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *
↳ page_size
int
Optional. The standard List page size.
↳ page_token
string
Optional. The standard List page token.
getProjectId
Required. The ID of the Google Cloud Platform project that the cluster
belongs to.
Returns
Type
Description
string
setProjectId
Required. The ID of the Google Cloud Platform project that the cluster
belongs to.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRegion
Required. The Dataproc region in which to handle the request.
Returns
Type
Description
string
setRegion
Required. The Dataproc region in which to handle the request.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. A filter constraining the clusters to list. Filters are
case-sensitive and have the following syntax:
field = value [AND [field = value]] ...
where field is one of status.state, clusterName, or labels.[KEY],
and [KEY] is a label key. value can be * to match all values.
status.state can be one of the following: ACTIVE, INACTIVE,
CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE
contains the CREATING, UPDATING, and RUNNING states. INACTIVE
contains the DELETING and ERROR states.
clusterName is the name of the cluster provided at creation time.
Only the logical AND operator is supported; space-separated items are
treated as having an implicit AND operator.
Example filter:
status.state = ACTIVE AND clusterName = mycluster
AND labels.env = staging AND labels.starred = *
Returns
Type
Description
string
setFilter
Optional. A filter constraining the clusters to list. Filters are
case-sensitive and have the following syntax:
field = value [AND [field = value]] ...
where field is one of status.state, clusterName, or labels.[KEY],
and [KEY] is a label key. value can be * to match all values.
status.state can be one of the following: ACTIVE, INACTIVE,
CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE
contains the CREATING, UPDATING, and RUNNING states. INACTIVE
contains the DELETING and ERROR states.
clusterName is the name of the cluster provided at creation time.
Only the logical AND operator is supported; space-separated items are
treated as having an implicit AND operator.
Example filter:
status.state = ACTIVE AND clusterName = mycluster
AND labels.env = staging AND labels.starred = *
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. The standard List page size.
Returns
Type
Description
int
setPageSize
Optional. The standard List page size.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. The standard List page token.
Returns
Type
Description
string
setPageToken
Optional. The standard List page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameters
Name
Description
projectId
string
Required. The ID of the Google Cloud Platform project that the cluster
belongs to.
region
string
Required. The Dataproc region in which to handle the request.
Required. The ID of the Google Cloud Platform project that the cluster
belongs to.
region
string
Required. The Dataproc region in which to handle the request.
filter
string
Optional. A filter constraining the clusters to list. Filters are
case-sensitive and have the following syntax:
field = value [AND [field = value]] ...
where field is one of status.state, clusterName, or labels.[KEY],
and [KEY] is a label key. value can be * to match all values.
status.state can be one of the following: ACTIVE, INACTIVE,
CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE
contains the CREATING, UPDATING, and RUNNING states. INACTIVE
contains the DELETING and ERROR states.
clusterName is the name of the cluster provided at creation time.
Only the logical AND operator is supported; space-separated items are
treated as having an implicit AND operator.
Example filter:
status.state = ACTIVE AND clusterName = mycluster
AND labels.env = staging AND labels.starred = *
[[["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 ListClustersRequest (3.14.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.14.0 (latest)](/php/docs/reference/cloud-dataproc/latest/V1.ListClustersRequest)\n- [3.13.4](/php/docs/reference/cloud-dataproc/3.13.4/V1.ListClustersRequest)\n- [3.12.0](/php/docs/reference/cloud-dataproc/3.12.0/V1.ListClustersRequest)\n- [3.11.0](/php/docs/reference/cloud-dataproc/3.11.0/V1.ListClustersRequest)\n- [3.10.1](/php/docs/reference/cloud-dataproc/3.10.1/V1.ListClustersRequest)\n- [3.9.0](/php/docs/reference/cloud-dataproc/3.9.0/V1.ListClustersRequest)\n- [3.8.1](/php/docs/reference/cloud-dataproc/3.8.1/V1.ListClustersRequest)\n- [3.7.1](/php/docs/reference/cloud-dataproc/3.7.1/V1.ListClustersRequest)\n- [3.6.1](/php/docs/reference/cloud-dataproc/3.6.1/V1.ListClustersRequest)\n- [3.5.1](/php/docs/reference/cloud-dataproc/3.5.1/V1.ListClustersRequest)\n- [3.4.0](/php/docs/reference/cloud-dataproc/3.4.0/V1.ListClustersRequest)\n- [3.3.0](/php/docs/reference/cloud-dataproc/3.3.0/V1.ListClustersRequest)\n- [3.2.2](/php/docs/reference/cloud-dataproc/3.2.2/V1.ListClustersRequest)\n- [2.6.1](/php/docs/reference/cloud-dataproc/2.6.1/V1.ListClustersRequest)\n- [2.5.0](/php/docs/reference/cloud-dataproc/2.5.0/V1.ListClustersRequest)\n- [2.3.0](/php/docs/reference/cloud-dataproc/2.3.0/V1.ListClustersRequest)\n- [2.2.3](/php/docs/reference/cloud-dataproc/2.2.3/V1.ListClustersRequest)\n- [2.1.0](/php/docs/reference/cloud-dataproc/2.1.0/V1.ListClustersRequest)\n- [2.0.0](/php/docs/reference/cloud-dataproc/2.0.0/V1.ListClustersRequest) \nReference documentation and code samples for the Google Cloud Dataproc V1 Client class ListClustersRequest.\n\nA request to list the clusters in a project.\n\nGenerated from protobuf message `google.cloud.dataproc.v1.ListClustersRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataproc \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProjectId\n\nRequired. The ID of the Google Cloud Platform project that the cluster\nbelongs to.\n\n### setProjectId\n\nRequired. The ID of the Google Cloud Platform project that the cluster\nbelongs to.\n\n### getRegion\n\nRequired. The Dataproc region in which to handle the request.\n\n### setRegion\n\nRequired. The Dataproc region in which to handle the request.\n\n### getFilter\n\nOptional. A filter constraining the clusters to list. Filters are\ncase-sensitive and have the following syntax:\nfield = value \\[AND \\[field = value\\]\\] ...\nwhere **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,\nand `[KEY]` is a label key. **value** can be `*` to match all values.\n\n`status.state` can be one of the following: `ACTIVE`, `INACTIVE`,\n`CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`\ncontains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`\ncontains the `DELETING` and `ERROR` states.\n`clusterName` is the name of the cluster provided at creation time.\nOnly the logical `AND` operator is supported; space-separated items are\ntreated as having an implicit `AND` operator.\nExample filter:\nstatus.state = ACTIVE AND clusterName = mycluster\nAND labels.env = staging AND labels.starred = \\*\n\n### setFilter\n\nOptional. A filter constraining the clusters to list. Filters are\ncase-sensitive and have the following syntax:\nfield = value \\[AND \\[field = value\\]\\] ...\nwhere **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,\nand `[KEY]` is a label key. **value** can be `*` to match all values.\n\n`status.state` can be one of the following: `ACTIVE`, `INACTIVE`,\n`CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`\ncontains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`\ncontains the `DELETING` and `ERROR` states.\n`clusterName` is the name of the cluster provided at creation time.\nOnly the logical `AND` operator is supported; space-separated items are\ntreated as having an implicit `AND` operator.\nExample filter:\nstatus.state = ACTIVE AND clusterName = mycluster\nAND labels.env = staging AND labels.starred = \\*\n\n### getPageSize\n\nOptional. The standard List page size.\n\n### setPageSize\n\nOptional. The standard List page size.\n\n### getPageToken\n\nOptional. The standard List page token.\n\n### setPageToken\n\nOptional. The standard List page token.\n\n### static::build\n\n### static::buildFromProjectIdRegionFilter"]]
