Class ListKeyRingsAsyncPager (3.2.0)

Version 3.2.0

• 3.2.1 (latest)
• 3.2.0
• 3.1.1
• 3.0.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.4
• 2.20.0
• 2.19.2
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.1
• 2.13.0
• 2.12.3
• 2.11.2
• 2.10.1
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.4.3
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0

ListKeyRingsAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.kms_v1.types.service.ListKeyRingsResponse]
    ],
    request: google.cloud.kms_v1.types.service.ListKeyRingsRequest,
    response: google.cloud.kms_v1.types.service.ListKeyRingsResponse,
    *,
    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_key_rings requests.

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

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

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

ListKeyRingsAsyncPager

ListKeyRingsAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.kms_v1.types.service.ListKeyRingsResponse]
    ],
    request: google.cloud.kms_v1.types.service.ListKeyRingsRequest,
    response: google.cloud.kms_v1.types.service.ListKeyRingsResponse,
    *,
    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]]] = ()
)

Instantiates the pager.

Parameters
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.kms_v1.types.ListKeyRingsRequest The initial request object.
response	google.cloud.kms_v1.types.ListKeyRingsResponse 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.