Class ListCustomersPager (1.19.0)

Version 1.19.0

• 1.20.1 (latest)
• 1.20.0
• 1.19.0
• 1.18.5
• 1.17.1
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.3
• 1.8.1
• 1.7.1
• 1.6.3
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.3
• 1.1.1
• 1.0.0
• 0.3.0
• 0.2.1
• 0.1.0

ListCustomersPager(
    method: typing.Callable[
        [...], google.cloud.channel_v1.types.service.ListCustomersResponse
    ],
    request: google.cloud.channel_v1.types.service.ListCustomersRequest,
    response: google.cloud.channel_v1.types.service.ListCustomersResponse,
    *,
    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_customers requests.

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

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

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

ListCustomersPager

ListCustomersPager(
    method: typing.Callable[
        [...], google.cloud.channel_v1.types.service.ListCustomersResponse
    ],
    request: google.cloud.channel_v1.types.service.ListCustomersRequest,
    response: google.cloud.channel_v1.types.service.ListCustomersResponse,
    *,
    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.channel_v1.types.ListCustomersRequest The initial request object.
response	google.cloud.channel_v1.types.ListCustomersResponse 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.