Module pagers (0.18.0)

API documentation for batch_v1.services.batch_service.pagers module.

Classes

ListJobsAsyncPager

ListJobsAsyncPager(
    method: typing.Callable[
        [...], typing.Awaitable[google.cloud.batch_v1.types.batch.ListJobsResponse]
    ],
    request: google.cloud.batch_v1.types.batch.ListJobsRequest,
    response: google.cloud.batch_v1.types.batch.ListJobsResponse,
    *,
    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_jobs requests.

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

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

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

ListJobsPager

ListJobsPager(
    method: typing.Callable[[...], google.cloud.batch_v1.types.batch.ListJobsResponse],
    request: google.cloud.batch_v1.types.batch.ListJobsRequest,
    response: google.cloud.batch_v1.types.batch.ListJobsResponse,
    *,
    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_jobs requests.

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

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

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

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

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.

ListTasksPager

ListTasksPager(
    method: typing.Callable[[...], 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.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]]] = ()
)