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, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.OpenSearchWrapperException
public class SearchParseException extends SearchException
Main error thrown if there is a problem during parsing a query
See Also:
Opensearch.internal:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.OpenSearchException

    org.opensearch.OpenSearchException.OpenSearchExceptionHandle, org.opensearch.OpenSearchException.OpenSearchExceptionHandleRegistry

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

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

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    UNKNOWN_POSITION
     

    Fields inherited from class org.opensearch.OpenSearchException

    headers, metadata, REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACE, UNKNOWN_VERSION_ADDED

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchParseException(org.opensearch.core.common.io.stream.StreamInput in)
     
    SearchParseException(SearchShardTarget shardTarget, String msg, org.opensearch.core.xcontent.XContentLocation location)
     
    SearchParseException(SearchShardTarget shardTarget, String msg, org.opensearch.core.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.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    org.opensearch.core.rest.RestStatus
    status()
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    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, getExceptionSimpleClassName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, headerToXContent, 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.core.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Constructor Details

    • SearchParseException

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

    • SearchParseException

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

    • SearchParseException

      public SearchParseException(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Overrides:
      writeTo in class SearchException
      Throws:
      IOException

    • status

      public org.opensearch.core.rest.RestStatus status()
      Overrides:
      status in class org.opensearch.OpenSearchException

    • metadataToXContent

      protected void metadataToXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Overrides:
      metadataToXContent in class org.opensearch.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