Package org.opensearch.action.search

Class SearchPhaseExecutionException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.opensearch.OpenSearchException
org.opensearch.action.search.SearchPhaseExecutionException
All Implemented Interfaces:
Serializable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
Direct Known Subclasses:
ReduceSearchPhaseException
public class SearchPhaseExecutionException extends org.opensearch.OpenSearchException
Main exception thrown when there is an error in the search phase
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 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
    SearchPhaseExecutionException(String phaseName, String msg, Throwable cause, ShardSearchFailure[] shardFailures)
     
    SearchPhaseExecutionException(String phaseName, String msg, ShardSearchFailure[] shardFailures)
     
    SearchPhaseExecutionException(org.opensearch.core.common.io.stream.StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Throwable
    getCause()
     
    String
    getPhaseName()
     
    org.opensearch.OpenSearchException[]
    guessRootCauses()
     
    protected void
    metadataToXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    ShardSearchFailure[]
    shardFailures()
     
    org.opensearch.core.rest.RestStatus
    status()
     
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    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, headerToXContent, innerFromXContent, innerToXContent, isRegistered, readException, readStackTrace, setIndex, setIndex, setResources, setShard, unwrapCause, writeStackTraces

    Methods inherited from class java.lang.Throwable

    addSuppressed, fillInStackTrace, 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.core.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

  • 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 org.opensearch.OpenSearchException
      Throws:
      IOException

    • status

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

    • shardFailures

      public ShardSearchFailure[] shardFailures()

    • getCause

      public Throwable getCause()
      Overrides:
      getCause in class Throwable

    • 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

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Overrides:
      toXContent in class org.opensearch.OpenSearchException
      Throws:
      IOException

    • guessRootCauses

      public org.opensearch.OpenSearchException[] guessRootCauses()
      Overrides:
      guessRootCauses in class org.opensearch.OpenSearchException

    • toString

      public String toString()
      Overrides:
      toString in class org.opensearch.OpenSearchException

    • getPhaseName

      public String getPhaseName()