Class ListClustersRequest (3.3.1)

ListClustersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A request to list the clusters in a project.

Attributes

NameDescription
project_id str
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
region str
Required. The Dataproc region in which to handle the request.
filter str
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 str
Optional. The standard List page token.

Inheritance

builtins.object > proto.message.Message > ListClustersRequest