Module pagers (0.5.13)

API documentation for api_keys_v2.services.api_keys.pagers module.

Classes

ListKeysAsyncPager

ListKeysAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.api_keys_v2.types.apikeys.ListKeysResponse]
    ],
    request: google.cloud.api_keys_v2.types.apikeys.ListKeysRequest,
    response: google.cloud.api_keys_v2.types.apikeys.ListKeysResponse,
    *,
    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_keys requests.

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

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

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

ListKeysPager

ListKeysPager(
    method: typing.Callable[
        [...], google.cloud.api_keys_v2.types.apikeys.ListKeysResponse
    ],
    request: google.cloud.api_keys_v2.types.apikeys.ListKeysRequest,
    response: google.cloud.api_keys_v2.types.apikeys.ListKeysResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_keys requests.

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

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

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