Class SearchAsyncPager (1.23.1)

Version latest

• 1.23.1 (latest)
• 1.23.0
• 1.22.0
• 1.21.2
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

SearchAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.search_service.SearchRequest,
    response: google.cloud.retail_v2beta.types.search_service.SearchResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.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: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2beta.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.retail_v2beta.types.search_service.SearchRequest,
    response: google.cloud.retail_v2beta.types.search_service.SearchResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

Parameters
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.retail_v2beta.types.SearchRequest The initial request object.
response	google.cloud.retail_v2beta.types.SearchResponse The initial response object.
retry	google.api_core.retry.AsyncRetry 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.