Class ListRestoresAsyncPager (0.5.14)

ListRestoresAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.gke_backup_v1.types.gkebackup.ListRestoresResponse
        ],
    ],
    request: google.cloud.gke_backup_v1.types.gkebackup.ListRestoresRequest,
    response: google.cloud.gke_backup_v1.types.gkebackup.ListRestoresResponse,
    *,
    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_restores requests.

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

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

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

ListRestoresAsyncPager

ListRestoresAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.gke_backup_v1.types.gkebackup.ListRestoresResponse
        ],
    ],
    request: google.cloud.gke_backup_v1.types.gkebackup.ListRestoresRequest,
    response: google.cloud.gke_backup_v1.types.gkebackup.ListRestoresResponse,
    *,
    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.gke_backup_v1.types.ListRestoresRequest

The initial request object.

response google.cloud.gke_backup_v1.types.ListRestoresResponse

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.