Module pagers (0.2.0)

API documentation for commerce_consumer_procurement_v1.services.consumer_procurement_service.pagers module.

Classes

ListOrdersAsyncPager

ListOrdersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.commerce_consumer_procurement_v1.types.procurement_service.ListOrdersResponse
        ],
    ],
    request: google.cloud.commerce_consumer_procurement_v1.types.procurement_service.ListOrdersRequest,
    response: google.cloud.commerce_consumer_procurement_v1.types.procurement_service.ListOrdersResponse,
    *,
    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_orders requests.

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

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

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

ListOrdersPager

ListOrdersPager(
    method: typing.Callable[
        [...],
        google.cloud.commerce_consumer_procurement_v1.types.procurement_service.ListOrdersResponse,
    ],
    request: google.cloud.commerce_consumer_procurement_v1.types.procurement_service.ListOrdersRequest,
    response: google.cloud.commerce_consumer_procurement_v1.types.procurement_service.ListOrdersResponse,
    *,
    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_orders requests.

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

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

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