Method: indexes.list

Full name: projects.locations.indexes.list

Lists Indexes in a Location.

Endpoint

gethttps://{service-endpoint}/v1/{parent}/indexes

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

parentstring

Required. The resource name of the Location from which to list the Indexes. Format:projects/{project}/locations/{location}

Query parameters

filterstring

The standard list filter.

pageSizeinteger

The standard list page size.

pageTokenstring

The standard list page token. Typically obtained viaListIndexesResponse.next_page_token of the previousIndexService.ListIndexes call.

readMaskstring (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message forIndexService.ListIndexes.

If successful, the response body contains data with the following structure:

Fields
indexes[]object (Index)

List of indexes in the requested page.

nextPageTokenstring

A token to retrieve next page of results. Pass toListIndexesRequest.page_token to obtain that page.

JSON representation
{"indexes":[{object (Index)}],"nextPageToken":string}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.