Module pagers (0.2.1)

Version 0.2.1

• 0.7.11 (latest)
• 0.7.10
• 0.6.0
• 0.5.1
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.0

API documentation for contentwarehouse_v1.services.document_service.pagers module.

Classes

SearchDocumentsAsyncPager

SearchDocumentsAsyncPager(
    method: Callable[
        [...],
        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,
    *,
    metadata: Sequence[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.

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]] = ()
)

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.