Java 8 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Java 8
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Java
8 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Java.
DatastoreNeedIndexException (Google App Engine API for Java)
Stay organized with collections
Save and categorize content based on your preferences.
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- com.google.appengine.api.datastore.DatastoreNeedIndexException
-
-
Method Summary
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
Constructor Detail
-
DatastoreNeedIndexException
public DatastoreNeedIndexException(java.lang.String message)
-
DatastoreNeedIndexException
public DatastoreNeedIndexException(java.lang.String message,
java.lang.Throwable cause)
-
Method Detail
-
getMessage
public java.lang.String getMessage()
- Overrides:
getMessage in class java.lang.Throwable
-
getMissingIndexDefinitionXml
public java.lang.String getMissingIndexDefinitionXml()
- Returns:
- The xml defining the missing index. Can be
null.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-16 UTC.
[[["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-06-16 UTC."],[[["\u003cp\u003e\u003ccode\u003eDatastoreNeedIndexException\u003c/code\u003e is a runtime exception that occurs when a query lacks a necessary index.\u003c/p\u003e\n"],["\u003cp\u003eThis exception indicates a problem with the application's indexing configuration, and it is necessary to verify both the datastore-indexes.xml file and the Indexes page in the Admin Console.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes constructors for creating the exception with a message or with a message and cause, for better handling.\u003c/p\u003e\n"],["\u003cp\u003eIt has methods \u003ccode\u003egetMessage\u003c/code\u003e and \u003ccode\u003egetMissingIndexDefinitionXml\u003c/code\u003e, to retrieve the message and the xml definition of the missing index respectively.\u003c/p\u003e\n"],["\u003cp\u003eThis exception inherits standard methods from \u003ccode\u003ejava.lang.Throwable\u003c/code\u003e and \u003ccode\u003ejava.lang.Object\u003c/code\u003e, such as \u003ccode\u003eprintStackTrace\u003c/code\u003e, \u003ccode\u003eequals\u003c/code\u003e, and \u003ccode\u003egetClass\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# DatastoreNeedIndexException (Google App Engine API for Java)\n\ncom.google.appengine.api.datastore\n\nClass DatastoreNeedIndexException\n---------------------------------\n\n- java.lang.Object\n-\n - java.lang.Throwable\n -\n - java.lang.Exception\n -\n - java.lang.RuntimeException\n -\n - com.google.appengine.api.datastore.DatastoreNeedIndexException\n\n-\n\n All Implemented Interfaces:\n : java.io.Serializable\n\n *** ** * ** ***\n\n \u003cbr /\u003e\n\n ```\n public class DatastoreNeedIndexException\n extends java.lang.RuntimeException\n ``` \n `DatastoreNeedIndexException` is thrown when no matching index was found for a query requiring an index. Check the Indexes page in the Admin Console and your datastore-indexes.xml file.\n\n See Also:\n: [Serialized Form](../../../../../serialized-form.html#com.google.appengine.api.datastore.DatastoreNeedIndexException) \n-\n -\n\n ### Constructor Summary\n\n \u003c!-- --\u003e\n\n -\n\n ### Method Summary\n\n -\n\n ### Methods inherited from class java.lang.Throwable\n\n `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`\n\n \u003c!-- --\u003e\n\n -\n\n ### Methods inherited from class java.lang.Object\n\n`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait` \n-\n -\n\n ### Constructor Detail\n\n\n -\n\n #### DatastoreNeedIndexException\n\n ```\n public DatastoreNeedIndexException(java.lang.String message)\n ```\n\n\n -\n\n #### DatastoreNeedIndexException\n\n ```\n public DatastoreNeedIndexException(java.lang.String message,\n java.lang.Throwable cause)\n ```\n\n \u003c!-- --\u003e\n\n -\n\n ### Method Detail\n\n\n -\n\n #### getMessage\n\n ```\n public java.lang.String getMessage()\n ```\n\n Overrides:\n : `getMessage` in class `java.lang.Throwable`\n\n\n -\n\n #### getMissingIndexDefinitionXml\n\n ```\n public java.lang.String getMissingIndexDefinitionXml()\n ```\n\n Returns:\n : The xml defining the missing index. Can be `null`."]]
