Class ElasticsearchException

All Implemented Interfaces:, Writeable, ToXContent, ToXContentFragment
Direct Known Subclasses:
AggregationExecutionException, AggregationInitializationException, AliasFilterParsingException, BlobStoreException, BroadcastShardOperationFailedException, CancellableThreads.ExecutionCancelledException, CircuitBreakingException, ClusterBlockException, CoordinationStateRejectedException, DelayRecoveryException, ElasticsearchGenerationException, ElasticsearchParseException, ElasticsearchStatusException, ElasticsearchTimeoutException, EngineException, FailedNodeException, FailedToCommitClusterStateException, GatewayException, GeneralScriptException, HttpException, IllegalIndexShardStateException, IncompatibleClusterStateVersionException, IndexClosedException, IndexCreationException, IndexPrimaryShardNotAllocatedException, IndexShardRecoveryException, IndexShardRestoreException, IndexShardSnapshotException, IndexTemplateMissingException, IngestProcessorException, InvalidAggregationPathException, InvalidAliasNameException, InvalidIndexNameException, InvalidIndexTemplateException, MapperException, MasterNotDiscoveredException, NodeClosedException, NoNodeAvailableException, NoShardAvailableActionException, NotMasterException, NotSerializableExceptionWrapper, ParsingException, PrimaryMissingActionException, ProcessClusterEventTimeoutException, QueryShardException, RecoverFilesRecoveryException, RecoveryFailedException, ReplicationOperation.RetryOnPrimaryException, RepositoryException, ResourceAlreadyExistsException, ResourceNotFoundException, RetentionLeaseInvalidRetainingSeqNoException, RoutingException, RoutingMissingException, ScriptException, SearchContextMissingException, SearchException, SearchPhaseExecutionException, SearchSourceBuilderException, SettingsException, ShardLockObtainFailedException, ShardStateAction.NoLongerPrimaryShardException, SnapshotException, SnapshotInProgressException, TaskCancelledException, TcpTransport.HttpRequestOnTransportException, TimestampParsingException, TranslogCorruptedException, TranslogException, TransportException, TransportReplicationAction.RetryOnReplicaException, TypeMissingException, UnavailableShardsException, UncategorizedExecutionException

public class ElasticsearchException
extends java.lang.RuntimeException
implements ToXContentFragment, Writeable
A base class for all elasticsearch exceptions.
See Also:
Serialized Form
  • Field Details

  • Constructor Details

    • ElasticsearchException

      public ElasticsearchException​(java.lang.Throwable cause)
      Construct a ElasticsearchException with the specified cause exception.
    • ElasticsearchException

      public ElasticsearchException​(java.lang.String msg, java.lang.Object... args)
      Construct a ElasticsearchException with the specified detail message. The message can be parameterized using {} as placeholders for the given arguments
      msg - the detail message
      args - the arguments for the message
    • ElasticsearchException

      public ElasticsearchException​(java.lang.String msg, java.lang.Throwable cause, java.lang.Object... args)
      Construct a ElasticsearchException with the specified detail message and nested exception. The message can be parameterized using {} as placeholders for the given arguments
      msg - the detail message
      cause - the nested exception
      args - the arguments for the message
    • ElasticsearchException

      public ElasticsearchException​(StreamInput in) throws
  • Method Details

    • addMetadata

      public void addMetadata​(java.lang.String key, java.lang.String... values)
      Adds a new piece of metadata with the given key. If the provided key is already present, the corresponding metadata will be replaced
    • addMetadata

      public void addMetadata​(java.lang.String key, java.util.List<java.lang.String> values)
      Adds a new piece of metadata with the given key. If the provided key is already present, the corresponding metadata will be replaced
    • getMetadataKeys

      public java.util.Set<java.lang.String> getMetadataKeys()
      Returns a set of all metadata keys on this exception
    • getMetadata

      public java.util.List<java.lang.String> getMetadata​(java.lang.String key)
      Returns the list of metadata values for the given key or null if no metadata for the given key exists.
    • getMetadata

      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getMetadata()
    • addHeader

      public void addHeader​(java.lang.String key, java.util.List<java.lang.String> value)
      Adds a new header with the given key. This method will replace existing header if a header with the same key already exists
    • addHeader

      public void addHeader​(java.lang.String key, java.lang.String... value)
      Adds a new header with the given key. This method will replace existing header if a header with the same key already exists
    • getHeaderKeys

      public java.util.Set<java.lang.String> getHeaderKeys()
      Returns a set of all header keys on this exception
    • getHeader

      public java.util.List<java.lang.String> getHeader​(java.lang.String key)
      Returns the list of header values for the given key or null if no header for the given key exists.
    • getHeaders

      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
    • status

      public RestStatus status()
      Returns the rest status code associated with this exception.
    • unwrapCause

      public java.lang.Throwable unwrapCause()
      Unwraps the actual cause from the exception for cases when the exception is a ElasticsearchWrapperException.
      See Also:
    • getDetailedMessage

      public java.lang.String getDetailedMessage()
      Return the detail message, including the message from the nested exception if there is one.
    • getRootCause

      public java.lang.Throwable getRootCause()
      Retrieve the innermost cause of this exception, if none, returns the current exception.
    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
    • readException

      public static ElasticsearchException readException​(StreamInput input, int id) throws
    • isRegistered

      public static boolean isRegistered​(java.lang.Class<? extends java.lang.Throwable> exception, Version version)
      Returns true iff the given class is a registered for an exception to be read.
    • getId

      public static int getId​(java.lang.Class<? extends ElasticsearchException> exception)
      Returns the serialization id the given exception.
    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws
      Specified by:
      toXContent in interface ToXContent
    • innerToXContent

      protected static void innerToXContent​(XContentBuilder builder, ToXContent.Params params, java.lang.Throwable throwable, java.lang.String type, java.lang.String message, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> metadata, java.lang.Throwable cause) throws
    • metadataToXContent

      protected void metadataToXContent​(XContentBuilder builder, ToXContent.Params params) throws
      Renders additional per exception information into the XContent
    • fromXContent

      public static ElasticsearchException fromXContent​(XContentParser parser) throws
      Generate a ElasticsearchException from a XContentParser. This does not return the original exception type (ie NodeClosedException for example) but just wraps the type, the reason and the cause of the exception. It also recursively parses the tree structure of the cause, returning it as a tree structure of ElasticsearchException instances.
    • innerFromXContent

      public static ElasticsearchException innerFromXContent​(XContentParser parser, boolean parseRootCauses) throws
    • generateThrowableXContent

      public static void generateThrowableXContent​(XContentBuilder builder, ToXContent.Params params, java.lang.Throwable t) throws
      Static toXContent helper method that renders ElasticsearchException or Throwable instances as XContent, delegating the rendering to toXContent(XContentBuilder, Params) or innerToXContent(XContentBuilder, Params, Throwable, String, String, Map, Map, Throwable). This method is usually used when the Throwable is rendered as a part of another XContent object, and its result can be parsed back using the fromXContent(XContentParser) method.
    • generateFailureXContent

      public static void generateFailureXContent​(XContentBuilder builder, ToXContent.Params params, @Nullable java.lang.Exception e, boolean detailed) throws
      Render any exception as a xcontent, encapsulated within a field or object named "error". The level of details that are rendered depends on the value of the "detailed" parameter: when it's false only a simple message based on the type and message of the exception is rendered. When it's true all detail are provided including guesses root causes, cause and potentially stack trace. This method is usually used when the Exception is rendered as a full XContent object, and its output can be parsed by the failureFromXContent(XContentParser) method.
    • failureFromXContent

      public static ElasticsearchException failureFromXContent​(XContentParser parser) throws
    • guessRootCauses

      public ElasticsearchException[] guessRootCauses()
      Returns the root cause of this exception or multiple if different shards caused different exceptions
    • guessRootCauses

      public static ElasticsearchException[] guessRootCauses​(java.lang.Throwable t)
      Returns the root cause of this exception or multiple if different shards caused different exceptions. If the given exception is not an instance of ElasticsearchException an empty array is returned.
    • getExceptionName

      protected java.lang.String getExceptionName()
    • getExceptionName

      public static java.lang.String getExceptionName​(java.lang.Throwable ex)
      Returns a underscore case name for the given exception. This method strips Elasticsearch prefixes from exception names.
    • toString

      public java.lang.String toString()
      toString in class java.lang.Throwable
    • readStackTrace

      public static <T extends java.lang.Throwable> T readStackTrace​(T throwable, StreamInput in) throws
      Deserializes stacktrace elements as well as suppressed exceptions from the given output stream and adds it to the given exception.
    • writeStackTraces

      public static <T extends java.lang.Throwable> T writeStackTraces​(T throwable, StreamOutput out) throws
      Serializes the given exceptions stacktrace elements as well as it's suppressed exceptions to the given output stream.
    • getIndex

      public Index getIndex()
    • getShardId

      public ShardId getShardId()
    • setIndex

      public void setIndex​(Index index)
    • setIndex

      public void setIndex​(java.lang.String index)
    • setShard

      public void setShard​(ShardId shardId)
    • setResources

      public void setResources​(java.lang.String type, java.lang.String... id)
    • getResourceId

      public java.util.List<java.lang.String> getResourceId()
    • getResourceType

      public java.lang.String getResourceType()