Class SearchExampleComparisonsPager (1.11.1)

SearchExampleComparisonsPager(
    method: typing.Callable[
        [...],
        google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsResponse,
    ],
    request: google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsRequest,
    response: google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsResponse,
    *,
    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 search_example_comparisons requests.

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

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

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

SearchExampleComparisonsPager

SearchExampleComparisonsPager(
    method: typing.Callable[
        [...],
        google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsResponse,
    ],
    request: google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsRequest,
    response: google.cloud.datalabeling_v1beta1.types.data_labeling_service.SearchExampleComparisonsResponse,
    *,
    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.datalabeling_v1beta1.types.SearchExampleComparisonsRequest` The initial request object.
`response`	`google.cloud.datalabeling_v1beta1.types.SearchExampleComparisonsResponse` 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.