Module pagers (1.37.0)

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

Classes

ListAgentsAsyncPager

ListAgentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.dialogflowcx_v3.types.agent.ListAgentsResponse],
    ],
    request: google.cloud.dialogflowcx_v3.types.agent.ListAgentsRequest,
    response: google.cloud.dialogflowcx_v3.types.agent.ListAgentsResponse,
    *,
    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_agents requests.

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

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

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

ListAgentsPager

ListAgentsPager(
    method: typing.Callable[
        [...], google.cloud.dialogflowcx_v3.types.agent.ListAgentsResponse
    ],
    request: google.cloud.dialogflowcx_v3.types.agent.ListAgentsRequest,
    response: google.cloud.dialogflowcx_v3.types.agent.ListAgentsResponse,
    *,
    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_agents requests.

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

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

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