def test_list_indexes(self):
# Setup Expected Response
next_page_token = ""
indexes_element = {}
indexes = [indexes_element]
expected_response = {
"next_page_token": next_page_token,
"indexes": indexes
}
expected_response = firestore_admin_pb2.ListIndexesResponse(
**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = firestore_admin_v1.FirestoreAdminClient()
# Setup Request
parent = client.parent_path("[PROJECT]", "[DATABASE]",
"[COLLECTION_ID]")
paged_list_response = client.list_indexes(parent)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.indexes[0] == resources[0]
assert len(channel.requests) == 1
expected_request = firestore_admin_pb2.ListIndexesRequest(
parent=parent)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def list_indexes(
self,
parent,
filter_=None,
page_size=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Lists composite indexes.
Example:
>>> from google.cloud import firestore_admin_v1
>>>
>>> client = firestore_admin_v1.FirestoreAdminClient()
>>>
>>> parent = client.parent_path('[PROJECT]', '[DATABASE]', '[COLLECTION_ID]')
>>>
>>> # Iterate over all results
>>> for element in client.list_indexes(parent):
... # process element
... pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_indexes(parent).pages:
... for element in page:
... # process element
... pass
Args:
parent (str): Required. A parent name of the form
``projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}``
filter_ (str): The filter to apply to list results.
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
resource, this parameter does not affect the return value. If page
streaming is performed per-page, this determines the maximum number
of resources in a page.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.api_core.page_iterator.PageIterator` instance.
An iterable of :class:`~google.cloud.firestore_admin_v1.types.Index` instances.
You can also iterate over the pages of the response
using its `pages` property.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
# Wrap the transport method to add retry and timeout logic.
if "list_indexes" not in self._inner_api_calls:
self._inner_api_calls[
"list_indexes"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.list_indexes,
default_retry=self._method_configs["ListIndexes"].retry,
default_timeout=self._method_configs["ListIndexes"].
timeout,
client_info=self._client_info,
)
request = firestore_admin_pb2.ListIndexesRequest(parent=parent,
filter=filter_,
page_size=page_size)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("parent", parent)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
iterator = google.api_core.page_iterator.GRPCIterator(
client=None,
method=functools.partial(
self._inner_api_calls["list_indexes"],
retry=retry,
timeout=timeout,
metadata=metadata,
),
request=request,
items_field="indexes",
request_token_field="page_token",
response_token_field="next_page_token",
)
return iterator