Method: indexes.list

Full name: projects.locations.indexes.list

Lists Indexes in a Location.

Endpoint

get https://{service-endpoint}/v1beta1/{parent}/indexes

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

parent string

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

Query parameters

filter string

The standard list filter.

pageSize integer

The standard list page size.

pageToken string

The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.

readMask string (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 for IndexService.ListIndexes .

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

Fields
indexes[] object (Index )

List of indexes in the requested page.

nextPageToken string

A token to retrieve next page of results. Pass to ListIndexesRequest.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 the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年06月27日 UTC.