Module pagers (0.1.2)

API documentation for developer_knowledge_v1.services.developer_knowledge.pagers module.

Classes

SearchDocumentChunksAsyncPager

SearchDocumentChunksAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse
        ],
    ],
    request: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksRequest,
    response: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

A pager for iterating through search_document_chunks requests.

This class thinly wraps an initial <xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref> object, and provides an __aiter__ method to iterate through its results field.

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

All the usual <xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref> attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SearchDocumentChunksPager

SearchDocumentChunksPager(
    method: typing.Callable[
        [...],
        google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse,
    ],
    request: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksRequest,
    response: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

A pager for iterating through search_document_chunks requests.

This class thinly wraps an initial <xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref> object, and provides an __iter__ method to iterate through its results field.

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

All the usual <xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref> attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.