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
Methods
__construct
Constructor.
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 fieldis one of status.state
, clusterName
, or labels.[KEY]
, and [KEY]
is a label key. valuecan 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.
string
setProjectId
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
var
string
$this
getRegion
Required. The Dataproc region in which to handle the request.
string
setRegion
Required. The Dataproc region in which to handle the request.
var
string
$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 fieldis one of status.state
, clusterName
, or labels.[KEY]
,
and [KEY]
is a label key. valuecan 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 = *
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 fieldis one of status.state
, clusterName
, or labels.[KEY]
,
and [KEY]
is a label key. valuecan 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 = *
var
string
$this
getPageSize
Optional. The standard List page size.
int
setPageSize
Optional. The standard List page size.
var
int
$this
getPageToken
Optional. The standard List page token.
string
setPageToken
Optional. The standard List page token.
var
string
$this
