Module pagers (2.16.1)

Version latest

• 2.16.1 (latest)
• 2.16.0
• 2.15.5
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.2
• 2.10.1
• 2.9.0
• 2.8.3
• 2.7.4
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.3
• 1.0.0
• 0.3.0
• 0.2.0
• 0.1.0

API documentation for recommender_v1.services.recommender.pagers module.

Classes

ListInsightsAsyncPager

ListInsightsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse
        ],
    ],
    request: google.cloud.recommender_v1.types.recommender_service.ListInsightsRequest,
    response: google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse,
    *,
    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_insights requests.

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

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

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

ListInsightsPager

ListInsightsPager(
    method: typing.Callable[
        [...],
        google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse,
    ],
    request: google.cloud.recommender_v1.types.recommender_service.ListInsightsRequest,
    response: google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse,
    *,
    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_insights requests.

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

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

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

ListRecommendationsAsyncPager

ListRecommendationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse
        ],
    ],
    request: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsRequest,
    response: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse,
    *,
    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_recommendations requests.

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

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

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

ListRecommendationsPager

ListRecommendationsPager(
    method: typing.Callable[
        [...],
        google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse,
    ],
    request: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsRequest,
    response: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse,
    *,
    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_recommendations requests.

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

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

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