Class ListEnginesAsyncPager (0.11.11)

ListEnginesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesRequest,
    response: google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_engines requests.

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

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

All the usual ListEnginesResponse 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

ListEnginesAsyncPager

ListEnginesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesRequest,
    response: google.cloud.discoveryengine_v1alpha.types.engine_service.ListEnginesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

Parameters
NameDescription
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.discoveryengine_v1alpha.types.ListEnginesRequest

The initial request object.

response google.cloud.discoveryengine_v1alpha.types.ListEnginesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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