SearchAsyncPager(
method: Callable[
[...], Awaitable[google.cloud.retail_v2.types.search_service.SearchResponse]
],
request: google.cloud.retail_v2.types.search_service.SearchRequest,
response: google.cloud.retail_v2.types.search_service.SearchResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()
)
A pager for iterating through search
requests.
This class thinly wraps an initial
SearchResponse object, and
provides an __aiter__
method to iterate through its
results
field.
If there are more pages, the __aiter__
method will make additional
Search
requests and continue to iterate
through the results
field on the
corresponding responses.
All the usual SearchResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
Methods
SearchAsyncPager
SearchAsyncPager(
method: Callable[
[...], Awaitable[google.cloud.retail_v2.types.search_service.SearchResponse]
],
request: google.cloud.retail_v2.types.search_service.SearchRequest,
response: google.cloud.retail_v2.types.search_service.SearchResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()
)
Instantiates the pager.
Name | Description |
method |
Callable
The method that was originally called, and which instantiated this pager. |
request |
google.cloud.retail_v2.types.SearchRequest
The initial request object. |
response |
google.cloud.retail_v2.types.SearchResponse
The initial response object. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |