java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.elasticsearch.ElasticsearchException
org.elasticsearch.search.SearchException
org.elasticsearch.search.query.SearchTimeoutException
- All Implemented Interfaces:
Serializable,Writeable,ElasticsearchWrapperException,ToXContent,ToXContentFragment
Specific instance of
SearchException that indicates that a search timeout occurred.
Always returns http status 429 (Too Many Requests)- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
Fields inherited from class org.elasticsearch.ElasticsearchException
REST_EXCEPTION_SKIP_CAUSE, REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACEFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidhandleTimeout(boolean allowPartialSearchResults, SearchShardTarget target, QuerySearchResult querySearchResult) Propagate a timeout according to whether partial search results are allowed or not.booleanReturns whether this exception represents a timeout.status()Returns the rest status code associated with this exception.Methods inherited from class org.elasticsearch.search.SearchException
shard, writeToMethods inherited from class org.elasticsearch.ElasticsearchException
addHeader, addHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, generateThrowableXContent, getDetailedMessage, getExceptionName, getExceptionName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, innerFromXContent, innerToXContent, isRegistered, metadataToXContent, readException, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, toXContent, unwrapCause, writeException, writeStackTraces, writeToMethods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTraceMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.ElasticsearchWrapperException
getCauseMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
SearchTimeoutException
-
SearchTimeoutException
- Throws:
IOException
-
-
Method Details
-
status
Description copied from class:ElasticsearchExceptionReturns the rest status code associated with this exception.- Overrides:
statusin classElasticsearchException
-
isTimeout
public boolean isTimeout()Description copied from class:ElasticsearchExceptionReturns whether this exception represents a timeout.- Overrides:
isTimeoutin classElasticsearchException
-
handleTimeout
public static void handleTimeout(boolean allowPartialSearchResults, SearchShardTarget target, QuerySearchResult querySearchResult) Propagate a timeout according to whether partial search results are allowed or not. In case partial results are allowed, a flag will be set to the providedQuerySearchResultto indicate that there was a timeout, but the execution will continue and partial results will be returned to the user. When partial results are disallowed, aSearchTimeoutExceptionwill be thrown and returned to the user.
-