Package org.opensearch

Class OpenSearchStatusException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.OpenSearchException

org.opensearch.OpenSearchStatusException

All Implemented Interfaces:

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

Direct Known Subclasses:

OpenSearchSecurityException

public class OpenSearchStatusException
extends OpenSearchException

Exception who's RestStatus is arbitrary rather than derived. Used, for example, by reindex-from-remote to wrap remote exceptions that contain a status.

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
OpenSearchStatusException(java.lang.String msg, RestStatus status, java.lang.Object... args)	Build the exception without a cause.
OpenSearchStatusException(java.lang.String msg, RestStatus status, java.lang.Throwable cause, java.lang.Object... args)	Build the exception with a specific status and cause.
OpenSearchStatusException(StreamInput in)	Read from a stream.

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

OpenSearchStatusException

public OpenSearchStatusException(java.lang.String msg, RestStatus status, java.lang.Throwable cause, java.lang.Object... args)

Build the exception with a specific status and cause.

OpenSearchStatusException

public OpenSearchStatusException(java.lang.String msg, RestStatus status, java.lang.Object... args)

Build the exception without a cause.

OpenSearchStatusException

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

Read from a stream.

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 final RestStatus status()

Description copied from class: OpenSearchException

Returns the rest status code associated with this exception.

Overrides:

status in class OpenSearchException