Class ListTopicSnapshotsAsyncPager (2.13.0)

ListTopicSnapshotsAsyncPager(
    method: Callable[
        [...], Awaitable[google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse]
    ],
    request: google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest,
    response: google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_topic_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicSnapshotsResponse object, and provides an __aiter__ method to iterate through its snapshots field.

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

All the usual google.pubsub_v1.types.ListTopicSnapshotsResponse 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 > ListTopicSnapshotsAsyncPager

Methods

ListTopicSnapshotsAsyncPager

ListTopicSnapshotsAsyncPager(
    method: Callable[
        [...], Awaitable[google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse]
    ],
    request: google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest,
    response: google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiates the pager.

Parameters
NameDescription
method Callable

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

request google.pubsub_v1.types.ListTopicSnapshotsRequest

The initial request object.

response google.pubsub_v1.types.ListTopicSnapshotsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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