Package org.opensearch

Class OpenSearchParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.OpenSearchException

org.opensearch.OpenSearchParseException

All Implemented Interfaces:

Serializable, Writeable, ToXContent, ToXContentFragment

@PublicApi(since="1.0.0")
public class OpenSearchParseException
extends OpenSearchException

Unchecked exception that is translated into a 400 BAD REQUEST error when it bubbles out over HTTP.

See Also:

• Serialized Form

Opensearch.api:

Nested Class Summary

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

OpenSearchException.OpenSearchExceptionHandle, OpenSearchException.OpenSearchExceptionHandleRegistry

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.WriteableRegistry, 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
OpenSearchParseException(String msg, Object... args)
OpenSearchParseException(String msg, Throwable cause, Object... args)
OpenSearchParseException(StreamInput in)

Method Summary

Modifier and Type	Method	Description
RestStatus	status()	Returns the rest status code associated with this exception.

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, metadataToXContent, readException, readStackTrace, setIndex, setIndex, setResources, setShard, toString, toXContent, unwrapCause, writeStackTraces, writeTo

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

isFragment

Constructor Details

OpenSearchParseException

public OpenSearchParseException(String msg,
 Object... args)

OpenSearchParseException

public OpenSearchParseException(String msg,
 Throwable cause,
 Object... args)

OpenSearchParseException

public OpenSearchParseException(StreamInput in)
                         throws IOException

Throws:

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