Module pagers (0.1.0)

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

Classes

QueryDataObjectsAsyncPager

QueryDataObjectsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.vectorsearch_v1beta.types.data_object_search_service.QueryDataObjectsResponse
        ],
    ],
    request: google.cloud.vectorsearch_v1beta.types.data_object_search_service.QueryDataObjectsRequest,
    response: google.cloud.vectorsearch_v1beta.types.data_object_search_service.QueryDataObjectsResponse,
    *,
    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 query_data_objects requests.

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

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

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

QueryDataObjectsPager

QueryDataObjectsPager(
    method: typing.Callable[
        [...],
        google.cloud.vectorsearch_v1beta.types.data_object_search_service.QueryDataObjectsResponse,
    ],
    request: google.cloud.vectorsearch_v1beta.types.data_object_search_service.QueryDataObjectsRequest,
    response: google.cloud.vectorsearch_v1beta.types.data_object_search_service.QueryDataObjectsResponse,
    *,
    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 query_data_objects requests.

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

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

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

SearchDataObjectsAsyncPager

SearchDataObjectsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.vectorsearch_v1beta.types.data_object_search_service.SearchDataObjectsResponse
        ],
    ],
    request: google.cloud.vectorsearch_v1beta.types.data_object_search_service.SearchDataObjectsRequest,
    response: google.cloud.vectorsearch_v1beta.types.data_object_search_service.SearchDataObjectsResponse,
    *,
    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 search_data_objects requests.

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

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

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

SearchDataObjectsPager

SearchDataObjectsPager(
    method: typing.Callable[
        [...],
        google.cloud.vectorsearch_v1beta.types.data_object_search_service.SearchDataObjectsResponse,
    ],
    request: google.cloud.vectorsearch_v1beta.types.data_object_search_service.SearchDataObjectsRequest,
    response: google.cloud.vectorsearch_v1beta.types.data_object_search_service.SearchDataObjectsResponse,
    *,
    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 search_data_objects requests.

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

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

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