Module pagers (0.2.0)

API documentation for retail_v2.services.catalog_service.pagers module.

Classes

ListCatalogsAsyncPager

ListCatalogsAsyncPager(
    method: Callable[
        [...],
        Awaitable[google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse],
    ],
    request: google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __aiter__ method to iterate through its catalogs field.

If there are more pages, the __aiter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCatalogsPager

ListCatalogsPager(
    method: Callable[
        [...], google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse
    ],
    request: google.cloud.retail_v2.types.catalog_service.ListCatalogsRequest,
    response: google.cloud.retail_v2.types.catalog_service.ListCatalogsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_catalogs requests.

This class thinly wraps an initial ListCatalogsResponse object, and provides an __iter__ method to iterate through its catalogs field.

If there are more pages, the __iter__ method will make additional ListCatalogs requests and continue to iterate through the catalogs field on the corresponding responses.

All the usual ListCatalogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.