Python 2.7 has reached end of supportand will bedeprecatedon January 31, 2026. After deprecation, you won't be able to deploy Python 2.7applications, even if your organization previously used an organization policy tore-enable deployments of legacy runtimes. Your existing Python2.7 applications will continue to run and receive traffic after theirdeprecation date. We recommend thatyoumigrate to the latest supported version of Python.

Functions

This API is supported for first-generation runtimes and can be used whenupgrading to corresponding second-generation runtimes. If you are updating to the App Engine Python 3 runtime, refer to themigration guide to learn about your migration options for legacy bundled services.

Thegoogle.appengine.api.search package includes the following function:

get_indexes(namespace='',offset=None,limit=None,start_index_name=None,include_start_index=True,index_name_prefix=None,fetch_schema=False,deadline=None)

Return list of available indexes.

Note: There is also a corresponding asynchronous method,get_indexes_async(), which is identical except it returns a future. To get the actual result, callget_result() on the returned value; that call will block.

Arguments

namespace

Namespace of indexes to return. If not set, the current namespace is used.

offset

Offset of first index to return.

limit

Number of indexes to return.

start_index_name

Name of first index to return.

include_start_index

Iftrue, include index specified bystart_index_name in results.

index_name_prefix

Prefix for selecting indexes to return.

fetch_schema

Specifies whether to fetch the schema for each index.

deadline

Deadline for RPC call in seconds.

Result value

GetResponse object representing a list of indexes. Iffetch_schema==true, each index will contain its schema.

Exceptions

TypeError

Invalid argument passed.

InternalError

Request failed on internal servers.

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-12-15 UTC.