Stay organized with collections
Save and categorize content based on your preferences.
publicclassGetRequest
A request to list objects in an index. You can specify a number of
restrictions, such as the number of objects to return, the id of the
first object to return, whether to only return keys, etc.
[[["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-03 UTC."],[[["\u003cp\u003e\u003ccode\u003eGetRequest\u003c/code\u003e is used to list objects in an index, allowing for restrictions like the number of objects to return and the ID of the first object.\u003c/p\u003e\n"],["\u003cp\u003eYou can set specific parameters when building a \u003ccode\u003eGetRequest\u003c/code\u003e object, like limiting the number of results, defining a starting ID, and indicating if only IDs should be returned, as shown with the \u003ccode\u003e.setLimit()\u003c/code\u003e, \u003ccode\u003e.setStartId()\u003c/code\u003e, and \u003ccode\u003e.setReturningIdsOnly()\u003c/code\u003e methods.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetRequest\u003c/code\u003e inherits several methods from the \u003ccode\u003eObject\u003c/code\u003e class, including \u003ccode\u003eclone()\u003c/code\u003e, \u003ccode\u003eequals()\u003c/code\u003e, \u003ccode\u003ehashCode()\u003c/code\u003e, \u003ccode\u003etoString()\u003c/code\u003e, and \u003ccode\u003ewait()\u003c/code\u003e among others.\u003c/p\u003e\n"],["\u003cp\u003eStatic methods \u003ccode\u003enewBuilder()\u003c/code\u003e allow for creating a \u003ccode\u003eGetRequest.Builder\u003c/code\u003e object, either from scratch or based on an existing \u003ccode\u003eGetRequest\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetRequest\u003c/code\u003e object contains methods such as \u003ccode\u003egetLimit()\u003c/code\u003e, \u003ccode\u003egetStartId()\u003c/code\u003e, \u003ccode\u003eisIncludeStart()\u003c/code\u003e, and \u003ccode\u003eisReturningIdsOnly()\u003c/code\u003e which allows for retrieving the request configurations.\u003c/p\u003e\n"]]],[],null,["# Class GetRequest (2.0.0)\n\n public class GetRequest\n\nA request to list objects in an index. You can specify a number of\nrestrictions, such as the number of objects to return, the id of the\nfirst object to return, whether to only return keys, etc. \n\n\n GetRequest request = GetRequest.newBuilder()\n .setLimit(500)\n .setStartId(\"some-id\")\n .setReturningIdsOnly(true)\n .build();\n \nInheritance\n-----------\n\n[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e GetRequest \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 GetRequest.Builder newBuilder()\n\n### newBuilder(GetRequest request)\n\n public static final GetRequest.Builder newBuilder(GetRequest request)\n\nConstructors\n------------\n\n### GetRequest(GetRequest.Builder builder)\n\n protected GetRequest(GetRequest.Builder builder)\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### getLimit()\n\n public int getLimit()\n\n### getStartId()\n\n public String getStartId()\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### isIncludeStart()\n\n public boolean isIncludeStart()\n\n### isReturningIdsOnly()\n\n public Boolean isReturningIdsOnly()\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--)"]]
