Class ListModelsPager (1.97.0)

ListModelsPager(
    method: typing.Callable[
        [...], google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse
    ],
    request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsRequest,
    response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse,
    *,
    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_models requests.

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

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

All the usual ListModelsResponse 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

ListModelsPager

ListModelsPager(
    method: typing.Callable[
        [...], google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse
    ],
    request: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsRequest,
    response: google.cloud.aiplatform_v1beta1.types.model_service.ListModelsResponse,
    *,
    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]]] = ()
)

Instantiate the pager.

Parameters
NameDescription
methodCallable

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

requestgoogle.cloud.aiplatform_v1beta1.types.ListModelsRequest

The initial request object.

responsegoogle.cloud.aiplatform_v1beta1.types.ListModelsResponse

The initial response object.

retrygoogle.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeoutfloat

The timeout for this request.

metadataSequence[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.