Sets the prefix to be matched against the names of returned indexes.
If the prefix is set to, say "a", only indexes with names starting with
'a' will be returned.
Sets the offset of the first index to return. This method comes with
a performance penalty and if you just want to page through all indexes
you should consider #setStartIndexName(String) method.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGetIndexesRequest.Builder\u003c/code\u003e class is used to construct \u003ccode\u003eGetIndexesRequest\u003c/code\u003e objects, facilitating the retrieval of index information.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify whether to fetch indexes from all namespaces or a specific namespace using the \u003ccode\u003esetAllNamespaces\u003c/code\u003e and \u003ccode\u003esetNamespace\u003c/code\u003e methods, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esetLimit\u003c/code\u003e method allows you to control the maximum number of indexes returned in a request, while \u003ccode\u003esetOffset\u003c/code\u003e allows to select the first index returned, but with performance implications.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter the indexes returned by specifying a prefix using \u003ccode\u003esetIndexNamePrefix\u003c/code\u003e, and choose if the schema is included with indexes using \u003ccode\u003esetSchemaFetched\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method creates and returns a new instance of \u003ccode\u003eGetIndexesRequest\u003c/code\u003e based on the configurations applied to this builder.\u003c/p\u003e\n"]]],[],null,["# Class GetIndexesRequest.Builder (2.0.0)\n\n public static final class GetIndexesRequest.Builder\n\nThe builder of [GetIndexesRequest](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GetIndexesRequest)s. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e GetIndexesRequest.Builder \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nMethods\n-------\n\n### build()\n\n public GetIndexesRequest build()\n\n### setAllNamespaces(boolean allNamespaces)\n\n public GetIndexesRequest.Builder setAllNamespaces(boolean allNamespaces)\n\nSets whether or not to fetch indexes from all namespaces.\n\n### setIncludeStartIndex(boolean includeStartIndex)\n\n public GetIndexesRequest.Builder setIncludeStartIndex(boolean includeStartIndex)\n\nSets whether or not to include the index whose name is specified via\nthe [#setStartIndexName(String)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GetIndexesRequest.Builder#com_google_appengine_api_search_GetIndexesRequest_Builder_setStartIndexName_java_lang_String_) method.\n\n### setIndexNamePrefix(String indexNamePrefix)\n\n public GetIndexesRequest.Builder setIndexNamePrefix(String indexNamePrefix)\n\nSets the prefix to be matched against the names of returned indexes.\nIf the prefix is set to, say \"a\", only indexes with names starting with\n'a' will be returned.\n\n### setLimit(Integer limit)\n\n public GetIndexesRequest.Builder setLimit(Integer limit)\n\nSets the maximum number of indexes to return.\n\n### setNamespace(String namespace)\n\n public GetIndexesRequest.Builder setNamespace(String namespace)\n\nSets the namespace to use for this request. Only indexes\ndefined within this namespace will be fetched.\n\n### setOffset(Integer offset)\n\n public GetIndexesRequest.Builder setOffset(Integer offset)\n\nSets the offset of the first index to return. This method comes with\na performance penalty and if you just want to page through all indexes\nyou should consider [#setStartIndexName(String)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GetIndexesRequest.Builder#com_google_appengine_api_search_GetIndexesRequest_Builder_setStartIndexName_java_lang_String_) method.\n\n### setSchemaFetched(boolean schemaFetched)\n\n public GetIndexesRequest.Builder setSchemaFetched(boolean schemaFetched)\n\nSets whether or not the schema is returned with indexes. An index schema\nis a map from field names to field types.\n\n### setStartIndexName(String startIndexName)\n\n public GetIndexesRequest.Builder setStartIndexName(String startIndexName)\n\nSets the name of the first index to return. You may exclude this index by\nusing the [#setIncludeStartIndex(boolean)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GetIndexesRequest.Builder#com_google_appengine_api_search_GetIndexesRequest_Builder_setIncludeStartIndex_boolean_) method."]]
