Class ListJobsAsyncPager (2.15.0)

ListJobsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.scheduler_v1beta1.types.cloudscheduler.ListJobsResponse
        ],
    ],
    request: google.cloud.scheduler_v1beta1.types.cloudscheduler.ListJobsRequest,
    response: google.cloud.scheduler_v1beta1.types.cloudscheduler.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.

Methods

ListJobsAsyncPager

ListJobsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.scheduler_v1beta1.types.cloudscheduler.ListJobsResponse
        ],
    ],
    request: google.cloud.scheduler_v1beta1.types.cloudscheduler.ListJobsRequest,
    response: google.cloud.scheduler_v1beta1.types.cloudscheduler.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]]] = ()
)

Instantiates the pager.

Parameters
Name Description
method Callable

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

request google.cloud.scheduler_v1beta1.types.ListJobsRequest

The initial request object.

response google.cloud.scheduler_v1beta1.types.ListJobsResponse

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.