Class ListContactsPager (1.2.0)

Version 1.2.0

• 1.8.1 (latest)
• 1.8.0
• 1.7.6
• 1.6.0
• 1.5.3
• 1.4.1
• 1.3.0
• 1.2.3
• 1.1.2
• 1.0.1
• 0.4.2
• 0.3.0
• 0.2.4
• 0.1.1

ListContactsPager(
    method: Callable[
        [...], google.cloud.essential_contacts_v1.types.service.ListContactsResponse
    ],
    request: google.cloud.essential_contacts_v1.types.service.ListContactsRequest,
    response: google.cloud.essential_contacts_v1.types.service.ListContactsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_contacts requests.

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

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

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

Inheritance

builtins.object > ListContactsPager

Methods

ListContactsPager

ListContactsPager(
    method: Callable[
        [...], google.cloud.essential_contacts_v1.types.service.ListContactsResponse
    ],
    request: google.cloud.essential_contacts_v1.types.service.ListContactsRequest,
    response: google.cloud.essential_contacts_v1.types.service.ListContactsResponse,
    *,
    metadata: Sequence[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.essential_contacts_v1.types.ListContactsRequest The initial request object.
response	google.cloud.essential_contacts_v1.types.ListContactsResponse The initial response object.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.