Class ListCatalogsPager (1.10.1)

Version 1.10.1

• 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

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.

Inheritance

builtins.object > ListCatalogsPager

Methods

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]] = ()
)

Instantiate the pager.

Parameters

Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.retail_v2.types.ListCatalogsRequest The initial request object.
response	google.cloud.retail_v2.types.ListCatalogsResponse The initial response object.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.