Checks the search options are valid, specifically, has a non-null
number of documents to return specification, a valid cursor if present,
valid sort specification list, a valid collection of field names for
sorting, and a valid scorer specification.
[[["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\u003eQueryOptionsChecker\u003c/code\u003e class is designed to validate the values within \u003ccode\u003eQueryOptions\u003c/code\u003e for the Google App Engine search API.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides static methods for checking the validity of field names, limits on the number of documents returned, and the accuracy of the number of documents found.\u003c/p\u003e\n"],["\u003cp\u003eIt includes methods for validating offsets and ensuring the overall validity of search parameters defined by \u003ccode\u003eSearchParams\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003echeckValid\u003c/code\u003e method validates that there is a specified number of documents to return, and verifies the presence of a cursor, sort specification, sorting field names, and scorer specification.\u003c/p\u003e\n"],["\u003cp\u003eThe class inherits standard methods like \u003ccode\u003eequals\u003c/code\u003e, \u003ccode\u003ehashCode\u003c/code\u003e, \u003ccode\u003etoString\u003c/code\u003e from the base \u003ccode\u003eObject\u003c/code\u003e class, which it inherits from.\u003c/p\u003e\n"]]],[],null,["# Class QueryOptionsChecker (2.0.0)\n\n public final class QueryOptionsChecker\n\nChecks values of [com.google.appengine.api.search.QueryOptions](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.QueryOptions). \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e QueryOptionsChecker \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### checkFieldNames(List\\\u003cString\\\u003e fieldNames)\n\n public static List\u003cString\u003e checkFieldNames(List\u003cString\u003e fieldNames)\n\nChecks that there are at most\n\nMAXIMUM_NUMBER_OF_FIELDS_TO_RETURN field names and\n==================================================\n\nthat each field name is valid.\n\n### checkLimit(int limit)\n\n public static int checkLimit(int limit)\n\nChecks whether the number of documents to return is between 1 and the\nmaximum.\n\n### checkNumberFoundAccuracy(int numberFoundAccuracy)\n\n public static int checkNumberFoundAccuracy(int numberFoundAccuracy)\n\nChecks whether the minimum number of documents found accuracy is between\n1 and the maximum.\n\n### checkOffset(Integer offset)\n\n public static Integer checkOffset(Integer offset)\n\nChecks whether the offset is between 0 and the maximum. Can be null.\n\n### checkValid(SearchServicePb.SearchParams params)\n\n public static SearchServicePb.SearchParams checkValid(SearchServicePb.SearchParams params)\n\nChecks the search options are valid, specifically, has a non-null\nnumber of documents to return specification, a valid cursor if present,\nvalid sort specification list, a valid collection of field names for\nsorting, and a valid scorer specification.\n\nConstructors\n------------\n\n### QueryOptionsChecker()\n\n public QueryOptionsChecker()"]]
