Class ListIndexesAsyncPager (1.83.0)

ListIndexesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            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,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_indexes requests.

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

If there are more pages, the __aiter__ 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.

Methods

ListIndexesAsyncPager

ListIndexesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            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,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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]]] = ()
)

Instantiates the pager.

Parameters
NameDescription
methodCallable

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

requestgoogle.cloud.aiplatform_v1beta1.types.ListIndexesRequest

The initial request object.

responsegoogle.cloud.aiplatform_v1beta1.types.ListIndexesResponse

The initial response object.

retrygoogle.api_core.retry.AsyncRetry

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.