Class ListDocumentsPager (2.29.0)

Version 2.29.0

• 3.1.0 (latest)
• 3.0.1
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

ListDocumentsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsRequest,
    response: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    *,
    metadata: typing.Sequence[typing.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 document_metadata field.

If there are more pages, the __iter__ method will make additional ListDocuments requests and continue to iterate through the document_metadata 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.

Methods

ListDocumentsPager

ListDocumentsPager(
    method: typing.Callable[
        [...],
        google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    ],
    request: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsRequest,
    response: google.cloud.documentai_v1beta3.types.document_service.ListDocumentsResponse,
    *,
    metadata: typing.Sequence[typing.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.documentai_v1beta3.types.ListDocumentsRequest The initial request object.
response	google.cloud.documentai_v1beta3.types.ListDocumentsResponse The initial response object.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.