Module pagers (3.0.0)

API documentation for kms_v1.services.autokey.pagers module.

Classes

ListKeyHandlesAsyncPager

ListKeyHandlesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.kms_v1.types.autokey.ListKeyHandlesResponse],
    ],
    request: google.cloud.kms_v1.types.autokey.ListKeyHandlesRequest,
    response: google.cloud.kms_v1.types.autokey.ListKeyHandlesResponse,
    *,
    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_key_handles requests.

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

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

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

ListKeyHandlesPager

ListKeyHandlesPager(
    method: typing.Callable[
        [...], google.cloud.kms_v1.types.autokey.ListKeyHandlesResponse
    ],
    request: google.cloud.kms_v1.types.autokey.ListKeyHandlesRequest,
    response: google.cloud.kms_v1.types.autokey.ListKeyHandlesResponse,
    *,
    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_key_handles requests.

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

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

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