Module pagers (0.10.18)

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

Classes

ListCatalogItemsAsyncPager

ListCatalogItemsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            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,
    *,
    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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through list_catalog_items requests.

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

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

ListCatalogItemsPager

ListCatalogItemsPager(
    method: typing.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,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

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.