Class ListAgentsPager (1.12.1)

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

Inheritance

builtins.object > ListAgentsPager

Methods

ListAgentsPager

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

The initial request object.

response google.cloud.dialogflowcx_v3.types.ListAgentsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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