Class ListVolumeRestoresPager (0.5.13)

ListVolumeRestoresPager(
    method: typing.Callable[
        [...], google.cloud.gke_backup_v1.types.gkebackup.ListVolumeRestoresResponse
    ],
    request: google.cloud.gke_backup_v1.types.gkebackup.ListVolumeRestoresRequest,
    response: google.cloud.gke_backup_v1.types.gkebackup.ListVolumeRestoresResponse,
    *,
    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_volume_restores requests.

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

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

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

ListVolumeRestoresPager

ListVolumeRestoresPager(
    method: typing.Callable[
        [...], google.cloud.gke_backup_v1.types.gkebackup.ListVolumeRestoresResponse
    ],
    request: google.cloud.gke_backup_v1.types.gkebackup.ListVolumeRestoresRequest,
    response: google.cloud.gke_backup_v1.types.gkebackup.ListVolumeRestoresResponse,
    *,
    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]] = ()
)

Instantiate 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.ListVolumeRestoresRequest

The initial request object.

response google.cloud.gke_backup_v1.types.ListVolumeRestoresResponse

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, str]]

Strings which should be sent along with the request as metadata.