Class ListSnapshotsPager (2.23.1)

ListSnapshotsPager(
    method: typing.Callable[[...], google.cloud.pubsub_v1.types.ListSnapshotsResponse],
    request: google.cloud.pubsub_v1.types.ListSnapshotsRequest,
    response: google.cloud.pubsub_v1.types.ListSnapshotsResponse,
    *,
    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_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.

Methods

ListSnapshotsPager

ListSnapshotsPager(
    method: typing.Callable[[...], google.cloud.pubsub_v1.types.ListSnapshotsResponse],
    request: google.cloud.pubsub_v1.types.ListSnapshotsRequest,
    response: google.cloud.pubsub_v1.types.ListSnapshotsResponse,
    *,
    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.pubsub_v1.types.ListSnapshotsRequest` The initial request object.
`response`	`google.pubsub_v1.types.ListSnapshotsResponse` 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.