Class ListTopicsPager (2.20.3)

ListTopicsPager(
    method: typing.Callable[[...], google.cloud.pubsub_v1.types.ListTopicsResponse],
    request: google.cloud.pubsub_v1.types.ListTopicsRequest,
    response: google.cloud.pubsub_v1.types.ListTopicsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_topics requests.

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

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

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

ListTopicsPager

ListTopicsPager(
    method: typing.Callable[[...], google.cloud.pubsub_v1.types.ListTopicsResponse],
    request: google.cloud.pubsub_v1.types.ListTopicsRequest,
    response: google.cloud.pubsub_v1.types.ListTopicsResponse,
    *,
    metadata: typing.Sequence[typing.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.ListTopicsRequest

The initial request object.

response google.pubsub_v1.types.ListTopicsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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