Module pagers (0.4.1)

Version 0.4.1

• 0.13.3 (latest)
• 0.13.2
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

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

Classes

ListDocumentsAsyncPager

ListDocumentsAsyncPager(
    method: Callable[
        [...],
        Awaitable[
            google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsRequest,
    response: google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_documents requests.

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

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

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

ListDocumentsPager

ListDocumentsPager(
    method: Callable[
        [...],
        google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsResponse,
    ],
    request: google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsRequest,
    response: google.cloud.discoveryengine_v1beta.types.document_service.ListDocumentsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_documents requests.

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

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

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