Class ListTopicsAsyncPager (2.25.1)

ListTopicsAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListTopicsResponse]
    ],
    request: google.cloud.pubsub_v1.types.ListTopicsRequest,
    response: google.cloud.pubsub_v1.types.ListTopicsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_topics requests.

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

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

ListTopicsAsyncPager

ListTopicsAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.pubsub_v1.types.ListTopicsResponse]
    ],
    request: google.cloud.pubsub_v1.types.ListTopicsRequest,
    response: google.cloud.pubsub_v1.types.ListTopicsResponse,
    *,
    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, str]] = ()
)

Instantiates the pager.

Parameters
Name Description
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.

retry google.api_core.retry.AsyncRetry

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.