Class ListJobsPager (0.6.1)

ListJobsPager(
    method: Callable[[...], google.cloud.dataflow_v1beta3.types.jobs.ListJobsResponse],
    request: google.cloud.dataflow_v1beta3.types.jobs.ListJobsRequest,
    response: google.cloud.dataflow_v1beta3.types.jobs.ListJobsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

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.

Inheritance

builtins.object > ListJobsPager

Methods

ListJobsPager

ListJobsPager(
    method: Callable[[...], google.cloud.dataflow_v1beta3.types.jobs.ListJobsResponse],
    request: google.cloud.dataflow_v1beta3.types.jobs.ListJobsRequest,
    response: google.cloud.dataflow_v1beta3.types.jobs.ListJobsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

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

request google.cloud.dataflow_v1beta3.types.ListJobsRequest

The initial request object.

response google.cloud.dataflow_v1beta3.types.ListJobsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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