Module subscriber.pagers (2.32.0)

API documentation for pubsub_v1.services.subscriber.pagers module.

Classes

ListSnapshotsAsyncPager

ListSnapshotsAsyncPager(
 method: typing.Callable[
 [...], typing.Awaitable[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_async.AsyncRetry,
 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_snapshots requests.

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

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

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, typing.Union[str, bytes]]] = ()
)

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.

ListSubscriptionsAsyncPager

ListSubscriptionsAsyncPager(
 method: typing.Callable[
 [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListSubscriptionsResponse]
 ],
 request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest,
 response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse,
 *,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 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_subscriptions requests.

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

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

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

ListSubscriptionsPager

ListSubscriptionsPager(
 method: typing.Callable[
 [...], google.cloud.pubsub_v1.types.ListSubscriptionsResponse
 ],
 request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest,
 response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse,
 *,
 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]]] = ()
)