Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products. If you have feedback or questions as you navigate the site, click Send Feedback.

Python 2 is no longer supported by the community. We recommend that you migrate Python 2 apps to Python 3.

Functions

Caution: **This solution is no longer recommended:** Apps that use this API can only run in the Python 2 runtime and will need to upgrade to a [recommended solution](/appengine/docs/legacy/standard/python/migrate-to-python3/migrating-services#migration_paths_for_bundled_services) before migrating to the Python 3 runtime.

The google.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, call get_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: If true, include index specified by start_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. If fetch_schema==true, each index will contain its schema.

Exceptions

TypeError: Invalid argument passed.
InternalError: Request failed on internal servers.