Class SearchDocumentsAsyncPager (0.7.11) 

SearchDocumentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest,
    response: google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through search_documents requests.

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

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

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

SearchDocumentsAsyncPager

SearchDocumentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse
        ],
    ],
    request: google.cloud.contentwarehouse_v1.types.document_service_request.SearchDocumentsRequest,
    response: google.cloud.contentwarehouse_v1.types.document_service.SearchDocumentsResponse,
    *,
    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, str]] = ()
)

Instantiates the pager.

Parameters
Name Description
method Callable

The method that was originally called, and which instantiated this pager.
request google.cloud.contentwarehouse_v1.types.SearchDocumentsRequest

The initial request object.
response google.cloud.contentwarehouse_v1.types.SearchDocumentsResponse

The initial response object.
retry google.api_core.retry.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

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