Module pagers (5.13.0)

API documentation for dataproc_v1.services.batch_controller.pagers module.

Classes

ListBatchesAsyncPager

ListBatchesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.dataproc_v1.types.batches.ListBatchesResponse],
    ],
    request: google.cloud.dataproc_v1.types.batches.ListBatchesRequest,
    response: google.cloud.dataproc_v1.types.batches.ListBatchesResponse,
    *,
    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_batches requests.

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

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

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

ListBatchesPager

ListBatchesPager(
    method: typing.Callable[
        [...], google.cloud.dataproc_v1.types.batches.ListBatchesResponse
    ],
    request: google.cloud.dataproc_v1.types.batches.ListBatchesRequest,
    response: google.cloud.dataproc_v1.types.batches.ListBatchesResponse,
    *,
    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_batches requests.

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

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

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