Stay organized with collections
Save and categorize content based on your preferences.
publicfinalclassGetIndexesRequest
A request to get a range of indexes. You can specify a number of
restrictions, such as the number of indexes to return, the prefix
with which names of the returned indexes must begin, etc.
A namespace may be specified, otherwise the default namespace will
be used. Only the indexes defined in the namespace, default or
otherwise, will be returned.
[[["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-08-07 UTC."],[[["\u003cp\u003e\u003ccode\u003eGetIndexesRequest\u003c/code\u003e is used to retrieve a range of indexes, allowing for restrictions on the number of indexes returned and the prefix of their names.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify a namespace to retrieve indexes within that specific namespace, or use the default namespace if none is provided.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003enewBuilder()\u003c/code\u003e method facilitates the creation of \u003ccode\u003eGetIndexesRequest\u003c/code\u003e instances, and there is also an overloaded method of it that takes an existing \u003ccode\u003eGetIndexesRequest\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThe class allows for control over the returned data, such as the maximum number of indexes via \u003ccode\u003egetLimit()\u003c/code\u003e, the starting point via \u003ccode\u003egetOffset()\u003c/code\u003e and the starting index name via \u003ccode\u003egetStartIndexName()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can use methods such as \u003ccode\u003eisAllNamespaces()\u003c/code\u003e and \u003ccode\u003eisSchemaFetched()\u003c/code\u003e to determine if indexes from all namespaces or index schema are returned, respectively.\u003c/p\u003e\n"]]],[],null,["# Class GetIndexesRequest (2.0.0)\n\n public final class GetIndexesRequest\n\nA request to get a range of indexes. You can specify a number of\nrestrictions, such as the number of indexes to return, the prefix\nwith which names of the returned indexes must begin, etc.\n\nA namespace may be specified, otherwise the default namespace will\nbe used. Only the indexes defined in the namespace, default or\notherwise, will be returned. \n\n\n GetIndexesRequest request = GetIndexesRequest.newBuilder()\n .setIndexNamePrefix(\"a\")\n .setOffset(100)\n .setLimit(10)\n .build();\n \nInheritance\n-----------\n\n[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e GetIndexesRequest \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\nStatic Methods\n--------------\n\n### newBuilder()\n\n public static final GetIndexesRequest.Builder newBuilder()\n\n### newBuilder(GetIndexesRequest request)\n\n public static final GetIndexesRequest.Builder newBuilder(GetIndexesRequest request)\n\nMethods\n-------\n\n### equals(Object obj)\n\n public boolean equals(Object obj)\n\n**Overrides** \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-)\n\n### getIndexNamePrefix()\n\n public String getIndexNamePrefix()\n\n### getLimit()\n\n public Integer getLimit()\n\n### getNamespace()\n\n public String getNamespace()\n\n### getOffset()\n\n public Integer getOffset()\n\n### getStartIndexName()\n\n public String getStartIndexName()\n\n### hashCode()\n\n public int hashCode()\n\n**Overrides** \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--)\n\n### isAllNamespaces()\n\n public Boolean isAllNamespaces()\n\n### isIncludeStartIndex()\n\n public boolean isIncludeStartIndex()\n\n### isSchemaFetched()\n\n public Boolean isSchemaFetched()\n\n### toString()\n\n public String toString()\n\n**Overrides** \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--)"]]
