Package org.opensearch.client.opensearch._types

Class OpenSearchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.client.opensearch._types.OpenSearchException

All Implemented Interfaces:

Serializable

public class OpenSearchException
extends RuntimeException

Exception thrown by API client methods when OpenSearch could not accept or process a request.

The error() contains the error's type and reason along with additional details that depend on the error type and the API endpoint that was called.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OpenSearchException(ErrorResponse response)

Method Summary

Modifier and Type	Method	Description
ErrorCause	error()	The cause of the error.
ErrorResponse	response()	The error response sent by OpenSearch
int	status()	Status code returned by OpenSearch.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OpenSearchException

public OpenSearchException(ErrorResponse response)

Method Details

response

public ErrorResponse response()

The error response sent by OpenSearch

error

public ErrorCause error()

The cause of the error. Shortcut for response().error().

status

public int status()

Status code returned by OpenSearch. Shortcut for response().status().