Module pagers (2.52.0)

API documentation for dialogflow_v2.services.companion_agents.pagers module.

Classes

ListCompanionAgentsAsyncPager

ListCompanionAgentsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.dialogflow_v2.types.companion_agent.ListCompanionAgentsResponse
        ],
    ],
    request: google.cloud.dialogflow_v2.types.companion_agent.ListCompanionAgentsRequest,
    response: google.cloud.dialogflow_v2.types.companion_agent.ListCompanionAgentsResponse,
    *,
    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 list_companion_agents requests.

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

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

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

ListCompanionAgentsPager

ListCompanionAgentsPager(
    method: typing.Callable[
        [...],
        google.cloud.dialogflow_v2.types.companion_agent.ListCompanionAgentsResponse,
    ],
    request: google.cloud.dialogflow_v2.types.companion_agent.ListCompanionAgentsRequest,
    response: google.cloud.dialogflow_v2.types.companion_agent.ListCompanionAgentsResponse,
    *,
    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 list_companion_agents requests.

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

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

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