# Class ListKeysPager (0.9.0)

0.9.0 (latest) 0.8.0 0.7.0 0.6.0 0.5.17 0.4.1 0.3.0 0.2.2 0.1.0

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

A pager for iterating through `list_keys` requests.

This class thinly wraps an initial
[ListKeysResponse](https://docs.cloud.google.com/python/docs/reference/apikeys/latest/google.cloud.api_keys_v2.types.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](https://docs.cloud.google.com/python/docs/reference/apikeys/latest/google.cloud.api_keys_v2.types.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.

## Methods

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

Instantiate the pager.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `method` | `Callable` The method that was originally called, and which instantiated this pager. |
| `request` | `https://docs.cloud.google.com/python/docs/reference/apikeys/latest/google.cloud.api_keys_v2.types.ListKeysRequest` The initial request object. |
| `response` | `https://docs.cloud.google.com/python/docs/reference/apikeys/latest/google.cloud.api_keys_v2.types.ListKeysResponse` The initial response object. |
| `retry` | `google.api_core.retry.Retry` 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`. |