Class ListCatalogItemsPager (0.5.1)

ListCatalogItemsPager(
    method: Callable[
        [...],
        google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse,
    ],
    request: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest,
    response: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_catalog_items requests.

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

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

All the usual ListCatalogItemsResponse 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

ListCatalogItemsPager

ListCatalogItemsPager(
    method: Callable[
        [...],
        google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse,
    ],
    request: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsRequest,
    response: google.cloud.recommendationengine_v1beta1.types.catalog_service.ListCatalogItemsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest

The initial request object.

response google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.