Class ListCustomJobsPager (1.16.1) 

ListCustomJobsPager(
    method: Callable[
        [...], google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse
    ],
    request: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsRequest,
    response: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_custom_jobs requests.

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

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

All the usual ListCustomJobsResponse 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 > ListCustomJobsPager

Methods

ListCustomJobsPager

ListCustomJobsPager(
    method: Callable[
        [...], google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse
    ],
    request: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsRequest,
    response: google.cloud.aiplatform_v1.types.job_service.ListCustomJobsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
Name Description
method Callable

The method that was originally called, and which instantiated this pager.
request google.cloud.aiplatform_v1.types.ListCustomJobsRequest

The initial request object.
response google.cloud.aiplatform_v1.types.ListCustomJobsResponse

The initial response object.
metadata Sequence[Tuple[str, str]]

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