Class ListTargetSitesPager (0.12.0) 

ListTargetSitesPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
    ],
    request: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesRequest,
    response: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
    *,
    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 list_target_sites requests.

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

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

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

ListTargetSitesPager

ListTargetSitesPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
    ],
    request: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesRequest,
    response: google.cloud.discoveryengine_v1alpha.types.site_search_engine_service.ListTargetSitesResponse,
    *,
    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.discoveryengine_v1alpha.types.ListTargetSitesRequest

The initial request object.
response google.cloud.discoveryengine_v1alpha.types.ListTargetSitesResponse

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.