Note: Python 2.7 has reached end of support on January 31, 2024. Your existing Python 2.7 applications will continue to run and receive traffic. However, App Engine might block re-deployment of applications that use runtimes after their end of support date. We recommend that you migrate to the latest supported version of Python.

Functions

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.