Search Index, gRPC: SearchIndexFileService.List
List files that are indexed within a specific search index.
gRPC request
rpc List (ListSearchIndexFilesRequest) returns (ListSearchIndexFilesResponse)
ListSearchIndexFilesRequest
{
"search_index_id": "string",
"page_size": "int64",
"page_token": "string"
}
Request message for listing files in a specific search index.
|
Field |
Description |
|
search_index_id |
string Required field. ID of the search index whose files will be listed. |
|
page_size |
int64 Maximum number of files to return per page. |
|
page_token |
string Token to retrieve the next page of results. |
ListSearchIndexFilesResponse
{
"files": [
{
"id": "string",
"search_index_id": "string",
"created_by": "string",
"created_at": "google.protobuf.Timestamp"
}
],
"next_page_token": "string"
}
Response message for the list operation.
|
Field |
Description |
|
files[] |
List of files in the specified search index. |
|
next_page_token |
string Token to retrieve the next page of results. |
SearchIndexFile
Represents a file that has been indexed within a search index.
|
Field |
Description |
|
id |
string Unique identifier of the file that was used for indexing. |
|
search_index_id |
string ID of the search index that contains this file. |
|
created_by |
string Identifier of the subject who created the file in the search index. |
|
created_at |
Timestamp representing when the file was created. |