Class ListServingConfigsPager (1.18.0)

ListServingConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    ],
    request: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_serving_configs requests.

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

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

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

ListServingConfigsPager

ListServingConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    ],
    request: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsRequest,
    response: google.cloud.retail_v2alpha.types.serving_config_service.ListServingConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

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

request google.cloud.retail_v2alpha.types.ListServingConfigsRequest

The initial request object.

response google.cloud.retail_v2alpha.types.ListServingConfigsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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