Class ListCachedContentsPager (1.62.0)

ListCachedContentsPager(
    method: typing.Callable[
        [...],
        google.cloud.aiplatform_v1beta1.types.gen_ai_cache_service.ListCachedContentsResponse,
    ],
    request: google.cloud.aiplatform_v1beta1.types.gen_ai_cache_service.ListCachedContentsRequest,
    response: google.cloud.aiplatform_v1beta1.types.gen_ai_cache_service.ListCachedContentsResponse,
    *,
    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_cached_contents requests.

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

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

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

ListCachedContentsPager

ListCachedContentsPager(
    method: typing.Callable[
        [...],
        google.cloud.aiplatform_v1beta1.types.gen_ai_cache_service.ListCachedContentsResponse,
    ],
    request: google.cloud.aiplatform_v1beta1.types.gen_ai_cache_service.ListCachedContentsRequest,
    response: google.cloud.aiplatform_v1beta1.types.gen_ai_cache_service.ListCachedContentsResponse,
    *,
    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.aiplatform_v1beta1.types.ListCachedContentsRequest

The initial request object.

response google.cloud.aiplatform_v1beta1.types.ListCachedContentsResponse

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.