Package org.opensearch.search

Class SearchParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.OpenSearchException

org.opensearch.search.SearchException

org.opensearch.search.SearchParseException

All Implemented Interfaces:

Serializable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, OpenSearchWrapperException

public class SearchParseException
extends SearchException

Main error thrown if there is a problem during parsing a query

See Also:

• Serialized Form

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	UNKNOWN_POSITION

Fields inherited from class org.opensearch.OpenSearchException

REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACE

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchParseException(StreamInput in)
SearchParseException(SearchShardTarget shardTarget, String msg, org.opensearch.common.xcontent.XContentLocation location)
SearchParseException(SearchShardTarget shardTarget, String msg, org.opensearch.common.xcontent.XContentLocation location, Throwable cause)

Method Summary

Modifier and Type	Method	Description
int	getColumnNumber()	Column number of the location of the error
int	getLineNumber()	Line number of the location of the error
protected void	metadataToXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)	Renders additional per exception information into the XContent
RestStatus	status()	Returns the rest status code associated with this exception.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.opensearch.search.SearchException

shard

Methods inherited from class org.opensearch.OpenSearchException

addHeader, addHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, getDetailedMessage, getExceptionName, getExceptionName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, innerFromXContent, innerToXContent, isRegistered, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, unwrapCause, writeStackTraces

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.OpenSearchWrapperException

getCause

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Field Details

UNKNOWN_POSITION

public static final int UNKNOWN_POSITION

See Also:

• Constant Field Values

Constructor Details

SearchParseException

public SearchParseException(SearchShardTarget shardTarget,
 String msg,
 @Nullable
 org.opensearch.common.xcontent.XContentLocation location)

SearchParseException

public SearchParseException(SearchShardTarget shardTarget,
 String msg,
 @Nullable
 org.opensearch.common.xcontent.XContentLocation location,
 Throwable cause)

SearchParseException

public SearchParseException(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SearchException

Throws:

IOException

status

public RestStatus status()

Description copied from class: OpenSearchException

Returns the rest status code associated with this exception.

Overrides:

status in class OpenSearchException

metadataToXContent

protected void metadataToXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                           throws IOException

Description copied from class: OpenSearchException

Renders additional per exception information into the XContent

Overrides:

metadataToXContent in class OpenSearchException

Throws:

IOException

getLineNumber

public int getLineNumber()

Line number of the location of the error

Returns:

the line number or -1 if unknown

getColumnNumber

public int getColumnNumber()

Column number of the location of the error

Returns:

the column number or -1 if unknown