Class ListSnapshotsPager (2.13.3)

ListSnapshotsPager(
    method: Callable[[...], google.cloud.pubsub_v1.types.ListSnapshotsResponse],
    request: google.cloud.pubsub_v1.types.ListSnapshotsRequest,
    response: google.cloud.pubsub_v1.types.ListSnapshotsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_snapshots requests.

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

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

All the usual google.pubsub_v1.types.ListSnapshotsResponse 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 > ListSnapshotsPager

Methods

ListSnapshotsPager

ListSnapshotsPager(
    method: Callable[[...], google.cloud.pubsub_v1.types.ListSnapshotsResponse],
    request: google.cloud.pubsub_v1.types.ListSnapshotsRequest,
    response: google.cloud.pubsub_v1.types.ListSnapshotsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

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

request google.pubsub_v1.types.ListSnapshotsRequest

The initial request object.

response google.pubsub_v1.types.ListSnapshotsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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