Class ListTopicSnapshotsPager (2.31.0)

ListTopicSnapshotsPager(
 method: typing.Callable[
 [...], google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse
 ],
 request: google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest,
 response: google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse,
 *,
 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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through list_topic_snapshots requests.

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

If there are more pages, the __iter__ 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.

Methods

ListTopicSnapshotsPager

ListTopicSnapshotsPager(
 method: typing.Callable[
 [...], google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse
 ],
 request: google.cloud.pubsub_v1.types.ListTopicSnapshotsRequest,
 response: google.cloud.pubsub_v1.types.ListTopicSnapshotsResponse,
 *,
 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, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

Parameters
Name	Description
`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.
`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, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Class ListTopicSnapshotsPager (2.31.0) Stay organized with collections Save and categorize content based on your preferences.

Methods

ListTopicSnapshotsPager

Class ListTopicSnapshotsPager (2.31.0)