Module pagers (1.21.2)

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

Classes

ListProductsAsyncPager

ListProductsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.retail_v2.types.product_service.ListProductsResponse
        ],
    ],
    request: google.cloud.retail_v2.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2.types.product_service.ListProductsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_products requests.

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

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

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

ListProductsPager

ListProductsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2.types.product_service.ListProductsResponse
    ],
    request: google.cloud.retail_v2.types.product_service.ListProductsRequest,
    response: google.cloud.retail_v2.types.product_service.ListProductsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_products requests.

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

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

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