Class ListRecommendersAsyncPager (2.15.5)

ListRecommendersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse
        ],
    ],
    request: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersRequest,
    response: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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_recommenders requests.

This class thinly wraps an initial ListRecommendersResponse object, and provides an __aiter__ method to iterate through its recommenders field.

If there are more pages, the __aiter__ method will make additional ListRecommenders requests and continue to iterate through the recommenders field on the corresponding responses.

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

ListRecommendersAsyncPager

ListRecommendersAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse
        ],
    ],
    request: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersRequest,
    response: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            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]] = ()
)

Instantiates the pager.

Parameters
Name Description
method Callable

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

request google.cloud.recommender_v1beta1.types.ListRecommendersRequest

The initial request object.

response google.cloud.recommender_v1beta1.types.ListRecommendersResponse

The initial response object.

retry google.api_core.retry.AsyncRetry

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.