Class ViewCollectionItemsPager (0.1.4)

ViewCollectionItemsPager(
    method: typing.Callable[
        [...], google.cloud.visionai_v1.types.warehouse.ViewCollectionItemsResponse
    ],
    request: google.cloud.visionai_v1.types.warehouse.ViewCollectionItemsRequest,
    response: google.cloud.visionai_v1.types.warehouse.ViewCollectionItemsResponse,
    *,
    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, str]] = ()
)

A pager for iterating through view_collection_items requests.

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

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

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

ViewCollectionItemsPager

ViewCollectionItemsPager(
    method: typing.Callable[
        [...], google.cloud.visionai_v1.types.warehouse.ViewCollectionItemsResponse
    ],
    request: google.cloud.visionai_v1.types.warehouse.ViewCollectionItemsRequest,
    response: google.cloud.visionai_v1.types.warehouse.ViewCollectionItemsResponse,
    *,
    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, str]] = ()
)

Instantiate the pager.

Parameters
Name Description
method Callable

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

request google.cloud.visionai_v1.types.ViewCollectionItemsRequest

The initial request object.

response google.cloud.visionai_v1.types.ViewCollectionItemsResponse

The initial response object.

retry google.api_core.retry.Retry

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.