Class ListRagFilesPager (1.48.0)

ListRagFilesPager(
    method: typing.Callable[
        [...],
        google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
    ],
    request: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesRequest,
    response: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_rag_files requests.

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

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

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

ListRagFilesPager

ListRagFilesPager(
    method: typing.Callable[
        [...],
        google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
    ],
    request: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesRequest,
    response: google.cloud.aiplatform_v1beta1.types.vertex_rag_data_service.ListRagFilesResponse,
    *,
    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.ListRagFilesRequest

The initial request object.

response google.cloud.aiplatform_v1beta1.types.ListRagFilesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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