Module pagers (0.1.6)

Version latest

• 0.1.6 (latest)
• 0.1.5

API documentation for managedkafka_v1.services.managed_kafka.pagers module.

Classes

ListClustersAsyncPager

ListClustersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse
        ],
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse,
    *,
    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_clusters requests.

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

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

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

ListClustersPager

ListClustersPager(
    method: typing.Callable[
        [...], google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListClustersResponse,
    *,
    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_clusters requests.

This class thinly wraps an initial ListClustersResponse object, and provides an __iter__ method to iterate through its clusters field.

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

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

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

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.

ListConsumerGroupsPager

ListConsumerGroupsPager(
    method: typing.Callable[
        [...],
        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.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_consumer_groups requests.

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

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

ListTopicsAsyncPager

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

A pager for iterating through list_topics requests.

This class thinly wraps an initial 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 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.

ListTopicsPager

ListTopicsPager(
    method: typing.Callable[
        [...], google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsResponse
    ],
    request: google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsRequest,
    response: google.cloud.managedkafka_v1.types.managed_kafka.ListTopicsResponse,
    *,
    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_topics requests.

This class thinly wraps an initial 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 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.