Module pagers (0.1.0)

API documentation for vectorsearch_v1beta.services.vector_search_service.pagers module.

Classes

ListCollectionsAsyncPager

ListCollectionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListCollectionsResponse
        ],
    ],
    request: google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListCollectionsRequest,
    response: google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListCollectionsResponse,
    *,
    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_collections requests.

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

If there are more pages, the __aiter__ method will make additional ListCollections requests and continue to iterate through the collections field on the corresponding responses.

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListCollectionsPager

ListCollectionsPager(
    method: typing.Callable[
        [...],
        google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListCollectionsResponse,
    ],
    request: google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListCollectionsRequest,
    response: google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListCollectionsResponse,
    *,
    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_collections requests.

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

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

All the usual ListCollectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListIndexesAsyncPager

ListIndexesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListIndexesResponse
        ],
    ],
    request: google.cloud.vectorsearch_v1beta.types.vectorsearch_service.ListIndexesRequest,
    response: google.cloud.vectorsearch_v1beta.types.vectorsearch_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.

ListIndexesPager

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