Class ListReferenceImagesPager (2.7.2) 

ListReferenceImagesPager(
    method: Callable[
        [...],
        google.cloud.vision_v1.types.product_search_service.ListReferenceImagesResponse,
    ],
    request: google.cloud.vision_v1.types.product_search_service.ListReferenceImagesRequest,
    response: google.cloud.vision_v1.types.product_search_service.ListReferenceImagesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_reference_images requests.

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

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

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

Inheritance

builtins.object > ListReferenceImagesPager

Methods

ListReferenceImagesPager

ListReferenceImagesPager(
    method: Callable[
        [...],
        google.cloud.vision_v1.types.product_search_service.ListReferenceImagesResponse,
    ],
    request: google.cloud.vision_v1.types.product_search_service.ListReferenceImagesRequest,
    response: google.cloud.vision_v1.types.product_search_service.ListReferenceImagesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

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

request google.cloud.vision_v1.types.ListReferenceImagesRequest

The initial request object.

response google.cloud.vision_v1.types.ListReferenceImagesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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