Class ListControlsPager (1.21.2)

Version 1.21.2

• 1.24.0 (latest)
• 1.23.1
• 1.22.0
• 1.21.2
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

ListControlsPager(
    method: typing.Callable[
        [...], google.cloud.retail_v2alpha.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2alpha.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2alpha.types.control_service.ListControlsResponse,
    *,
    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_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_v2alpha.types.control_service.ListControlsResponse
    ],
    request: google.cloud.retail_v2alpha.types.control_service.ListControlsRequest,
    response: google.cloud.retail_v2alpha.types.control_service.ListControlsResponse,
    *,
    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]] = ()
)

Instantiate the pager.

Parameters
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.retail_v2alpha.types.ListControlsRequest The initial request object.
response	google.cloud.retail_v2alpha.types.ListControlsResponse The initial response object.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.