Module pagers (1.37.0)

API documentation for dialogflowcx_v3.services.pages.pagers module.

Classes

ListPagesAsyncPager

ListPagesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.dialogflowcx_v3.types.page.ListPagesResponse],
    ],
    request: google.cloud.dialogflowcx_v3.types.page.ListPagesRequest,
    response: google.cloud.dialogflowcx_v3.types.page.ListPagesResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_pages requests.

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

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

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

ListPagesPager

ListPagesPager(
    method: typing.Callable[
        [...], google.cloud.dialogflowcx_v3.types.page.ListPagesResponse
    ],
    request: google.cloud.dialogflowcx_v3.types.page.ListPagesRequest,
    response: google.cloud.dialogflowcx_v3.types.page.ListPagesResponse,
    *,
    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, str]] = ()
)

A pager for iterating through list_pages requests.

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

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

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