Class ListHyperparameterTuningJobsPager (0.8.0)

ListHyperparameterTuningJobsPager(
    method: Callable[
        [...],
        google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
    ],
    request: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsRequest,
    response: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_hyperparameter_tuning_jobs requests.

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

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

All the usual ListHyperparameterTuningJobsResponse 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 > ListHyperparameterTuningJobsPager

Methods

ListHyperparameterTuningJobsPager

ListHyperparameterTuningJobsPager(
    method: Callable[
        [...],
        google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
    ],
    request: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsRequest,
    response: google.cloud.aiplatform_v1.types.job_service.ListHyperparameterTuningJobsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
methodCallable

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

requestgoogle.cloud.aiplatform_v1.types.ListHyperparameterTuningJobsRequest

The initial request object.

responsegoogle.cloud.aiplatform_v1.types.ListHyperparameterTuningJobsResponse

The initial response object.

metadataSequence[Tuple[str, str]]

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