Class ListControlsPager (1.17.0)

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2beta.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2beta.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_controls requests.

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

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

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

ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2beta.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2beta.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2beta.types.control_service.ListControlsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

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

request google.cloud.retail_v2beta.types.ListControlsRequest

The initial request object.

response google.cloud.retail_v2beta.types.ListControlsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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