Class ListCollectionsAsyncPager (0.1.2)

ListCollectionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.visionai_v1.types.warehouse.ListCollectionsResponse
        ],
    ],
    request: google.cloud.visionai_v1.types.warehouse.ListCollectionsRequest,
    response: google.cloud.visionai_v1.types.warehouse.ListCollectionsResponse,
    *,
    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_collections requests.

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

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

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

ListCollectionsAsyncPager

ListCollectionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.visionai_v1.types.warehouse.ListCollectionsResponse
        ],
    ],
    request: google.cloud.visionai_v1.types.warehouse.ListCollectionsRequest,
    response: google.cloud.visionai_v1.types.warehouse.ListCollectionsResponse,
    *,
    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.visionai_v1.types.ListCollectionsRequest

The initial request object.

response google.cloud.visionai_v1.types.ListCollectionsResponse

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.