def __init__(self,
method: Callable[..., clusters.ListClustersResponse],
request: clusters.ListClustersRequest,
response: clusters.ListClustersResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.cloud.dataproc_v1beta2.types.ListClustersRequest):
The initial request object.
response (google.cloud.dataproc_v1beta2.types.ListClustersResponse):
The initial response object.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = clusters.ListClustersRequest(request)
self._response = response
self._metadata = metadata
def list_clusters(
self,
request: clusters.ListClustersRequest = None,
*,
project_id: str = None,
region: str = None,
filter: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListClustersPager:
r"""Lists all regions/{region}/clusters in a project
alphabetically.
Args:
request (:class:`~.clusters.ListClustersRequest`):
The request object. A request to list the clusters in a
project.
project_id (:class:`str`):
Required. The ID of the Google Cloud
Platform project that the cluster
belongs to.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
region (:class:`str`):
Required. The Dataproc region in
which to handle the request.
This corresponds to the ``region`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
filter (:class:`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 = \*
This corresponds to the ``filter`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.pagers.ListClustersPager:
The list of all clusters in a
project.
Iterating over this object will yield
results and resolve additional pages
automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, region, filter])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a clusters.ListClustersRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, clusters.ListClustersRequest):
request = clusters.ListClustersRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if region is not None:
request.region = region
if filter is not None:
request.filter = filter
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_clusters]
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListClustersPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
async def list_clusters(
self,
request: clusters.ListClustersRequest = None,
*,
project_id: str = None,
region: str = None,
filter: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListClustersAsyncPager:
r"""Lists all regions/{region}/clusters in a project
alphabetically.
Args:
request (:class:`google.cloud.dataproc_v1beta2.types.ListClustersRequest`):
The request object. A request to list the clusters in a
project.
project_id (:class:`str`):
Required. The ID of the Google Cloud
Platform project that the cluster
belongs to.
This corresponds to the ``project_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
region (:class:`str`):
Required. The Dataproc region in
which to handle the request.
This corresponds to the ``region`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
filter (:class:`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 = \*
This corresponds to the ``filter`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.dataproc_v1beta2.services.cluster_controller.pagers.ListClustersAsyncPager:
The list of all clusters in a
project.
Iterating over this object will yield
results and resolve additional pages
automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([project_id, region, filter])
if request is not None and has_flattened_params:
raise ValueError(
"If the `request` argument is set, then none of "
"the individual field arguments should be set."
)
request = clusters.ListClustersRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if project_id is not None:
request.project_id = project_id
if region is not None:
request.region = region
if filter is not None:
request.filter = filter
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.list_clusters,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded,
exceptions.InternalServerError,
exceptions.ServiceUnavailable,
),
deadline=300.0,
),
default_timeout=300.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# This method is paged; wrap the response in a pager, which provides
# an `__aiter__` convenience method.
response = pagers.ListClustersAsyncPager(
method=rpc, request=request, response=response, metadata=metadata,
)
# Done; return the response.
return response