Class ListTasksAsyncPager (0.17.26)

ListTasksAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.batch_v1.types.batch.ListTasksResponse]
    ],
    request: google.cloud.batch_v1.types.batch.ListTasksRequest,
    response: google.cloud.batch_v1.types.batch.ListTasksResponse,
    *,
    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_tasks requests.

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

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

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

ListTasksAsyncPager

ListTasksAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.batch_v1.types.batch.ListTasksResponse]
    ],
    request: google.cloud.batch_v1.types.batch.ListTasksRequest,
    response: google.cloud.batch_v1.types.batch.ListTasksResponse,
    *,
    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]] = ()
)

Instantiates the pager.

Parameters
Name Description
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.batch_v1.types.ListTasksRequest

The initial request object.

response google.cloud.batch_v1.types.ListTasksResponse

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

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