Class ListDocumentSchemasPager (0.1.0)

ListDocumentSchemasPager(
    method: Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest,
    response: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_document_schemas requests.

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

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

All the usual ListDocumentSchemasResponse 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 > ListDocumentSchemasPager

Methods

ListDocumentSchemasPager

ListDocumentSchemasPager(
    method: Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasRequest,
    response: google.cloud.contentwarehouse_v1.types.document_schema_service.ListDocumentSchemasResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.contentwarehouse_v1.types.ListDocumentSchemasRequest

The initial request object.

response google.cloud.contentwarehouse_v1.types.ListDocumentSchemasResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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