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:

java.io.Serializable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

Direct Known Subclasses:

ReduceSearchPhaseException

public class SearchPhaseExecutionException
extends OpenSearchException

See Also:

Serialized Form

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 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
SearchPhaseExecutionException(java.lang.String phaseName, java.lang.String msg, java.lang.Throwable cause, ShardSearchFailure[] shardFailures)
SearchPhaseExecutionException(java.lang.String phaseName, java.lang.String msg, ShardSearchFailure[] shardFailures)
SearchPhaseExecutionException(StreamInput in)

Method Summary

Modifier and Type	Method	Description
java.lang.Throwable	getCause()
java.lang.String	getPhaseName()
OpenSearchException[]	guessRootCauses()	Returns the root cause of this exception or multiple if different shards caused different exceptions
protected void	metadataToXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)	Renders additional per exception information into the XContent
ShardSearchFailure[]	shardFailures()
RestStatus	status()	Returns the rest status code associated with this exception.
java.lang.String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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, 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.common.xcontent.ToXContentFragment

isFragment

Constructor Details

SearchPhaseExecutionException

public SearchPhaseExecutionException(java.lang.String phaseName, java.lang.String msg, ShardSearchFailure[] shardFailures)

SearchPhaseExecutionException

public SearchPhaseExecutionException(java.lang.String phaseName, java.lang.String msg, java.lang.Throwable cause, ShardSearchFailure[] shardFailures)

SearchPhaseExecutionException

public SearchPhaseExecutionException(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class OpenSearchException

Throws:

java.io.IOException

status

public RestStatus status()

Description copied from class: OpenSearchException

Returns the rest status code associated with this exception.

Overrides:

status in class OpenSearchException

shardFailures

public ShardSearchFailure[] shardFailures()

getCause

public java.lang.Throwable getCause()

Overrides:

getCause in class java.lang.Throwable

metadataToXContent

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

Description copied from class: OpenSearchException

Renders additional per exception information into the XContent

Overrides:

metadataToXContent in class OpenSearchException

Throws:

java.io.IOException

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Overrides:

toXContent in class OpenSearchException

Throws:

java.io.IOException

guessRootCauses

public OpenSearchException[] guessRootCauses()

Description copied from class: OpenSearchException

Returns the root cause of this exception or multiple if different shards caused different exceptions

Overrides:

guessRootCauses in class OpenSearchException

toString

public java.lang.String toString()

Overrides:

toString in class OpenSearchException

getPhaseName

public java.lang.String getPhaseName()