Class ListIndexesPager (1.13.0)

ListIndexesPager(
    method: Callable[
        [...], google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse
    ],
    request: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest,
    response: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_indexes requests.

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

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

All the usual ListIndexesResponse 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 > ListIndexesPager

Methods

ListIndexesPager

ListIndexesPager(
    method: Callable[
        [...], google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse
    ],
    request: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest,
    response: google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesResponse,
    *,
    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.aiplatform_v1beta1.types.ListIndexesRequest

The initial request object.

response google.cloud.aiplatform_v1beta1.types.ListIndexesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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