Class ListSessionsAsyncPager (0.13.1)

Version 0.13.1

• 0.13.2 (latest)
• 0.13.1
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

ListSessionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsRequest,
    response: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsResponse,
    *,
    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_sessions requests.

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

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

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

Methods

ListSessionsAsyncPager

ListSessionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsRequest,
    response: google.cloud.discoveryengine_v1alpha.types.conversational_search_service.ListSessionsResponse,
    *,
    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]] = ()
)

Instantiates the pager.

Parameters
Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.discoveryengine_v1alpha.types.ListSessionsRequest The initial request object.
response	google.cloud.discoveryengine_v1alpha.types.ListSessionsResponse The initial response object.
retry	google.api_core.retry.AsyncRetry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.