Module pagers (0.11.4rc0)

API documentation for discoveryengine_v1.services.search_service.pagers module.

Classes

SearchAsyncPager

SearchAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.search_service.SearchResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.search_service.SearchRequest,
    response: google.cloud.discoveryengine_v1.types.search_service.SearchResponse,
    *,
    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.

SearchPager

SearchPager(
    method: typing.Callable[
        [...], google.cloud.discoveryengine_v1.types.search_service.SearchResponse
    ],
    request: google.cloud.discoveryengine_v1.types.search_service.SearchRequest,
    response: google.cloud.discoveryengine_v1.types.search_service.SearchResponse,
    *,
    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 __iter__ method to iterate through its results field.

If there are more pages, the __iter__ 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.