Class SearchDocumentsPager (0.1.0)

SearchDocumentsPager(
    method: Callable[
        [...],
        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,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through search_documents requests.

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

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

Inheritance

builtins.object > SearchDocumentsPager

Methods

SearchDocumentsPager

SearchDocumentsPager(
    method: Callable[
        [...],
        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,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate 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.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.