Class ListConsumerGroupsAsyncPager (0.1.4)

Version latest

• 0.1.4 (latest)
• 0.1.3

ListConsumerGroupsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse
        ],
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse,
    *,
    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_consumer_groups requests.

This class thinly wraps an initial ListConsumerGroupsResponse object, and provides an __aiter__ method to iterate through its consumer_groups field.

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

All the usual ListConsumerGroupsResponse 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

ListConsumerGroupsAsyncPager

ListConsumerGroupsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse
        ],
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListConsumerGroupsResponse,
    *,
    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.cloud.managedkafka_v1.types.ListConsumerGroupsRequest The initial request object.
response	google.cloud.managedkafka_v1.types.ListConsumerGroupsResponse 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.