Package org.opensearch.index.query

Class QueryShardException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.OpenSearchException

org.opensearch.index.query.QueryShardException

All Implemented Interfaces:

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

public class QueryShardException
extends OpenSearchException

Exception that is thrown when creating lucene queries on the shard

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
QueryShardException(StreamInput in)
QueryShardException(Index index, java.lang.String msg, java.lang.Throwable cause, java.lang.Object... args)	This constructor is provided for use in unit tests where a QueryShardContext may not be available
QueryShardException(QueryShardContext context, java.lang.String msg, java.lang.Object... args)
QueryShardException(QueryShardContext context, java.lang.String msg, java.lang.Throwable cause, java.lang.Object... args)

Method Summary

Modifier and Type	Method	Description
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.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, metadataToXContent, 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.common.xcontent.ToXContentFragment

isFragment

Constructor Details

QueryShardException

public QueryShardException(QueryShardContext context, java.lang.String msg, java.lang.Object... args)

QueryShardException

public QueryShardException(QueryShardContext context, java.lang.String msg, java.lang.Throwable cause, java.lang.Object... args)

QueryShardException

public QueryShardException(Index index, java.lang.String msg, java.lang.Throwable cause, java.lang.Object... args)

This constructor is provided for use in unit tests where a QueryShardContext may not be available

QueryShardException

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

Throws:

java.io.IOException

Method Details

status

public RestStatus status()

Description copied from class: OpenSearchException

Returns the rest status code associated with this exception.

Overrides:

status in class OpenSearchException

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