Class ListSubscriptionsPager (2.22.0)

ListSubscriptionsPager(
    method: typing.Callable[
        [...], google.cloud.pubsub_v1.types.ListSubscriptionsResponse
    ],
    request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest,
    response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_subscriptions requests.

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

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

Methods

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,
    *,
    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.ListSubscriptionsRequest

The initial request object.

response google.pubsub_v1.types.ListSubscriptionsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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