Package org.opensearch.client.opensearch._types

Class ErrorCause

  • All Implemented Interfaces:
    JsonpSerializable
    @JsonpDeserializable
public class ErrorCause
extends java.lang.Object
implements JsonpSerializable
    Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • Method Detail

      • metadata

        public final java.util.Map<java.lang.String,​JsonData> metadata()
        Additional details about the error

      • type

        public final java.lang.String type()
        Required - The type of error

        API name: type

      • reason

        public final java.lang.String reason()
        Required - A human-readable explanation of the error, in english

        API name: reason

      • stackTrace

        @Nullable
public final java.lang.String stackTrace()
        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        API name: stack_trace

      • causedBy

        @Nullable
public final ErrorCause causedBy()
        API name: caused_by

      • rootCause

        public final java.util.List<ErrorCause> rootCause()
        API name: root_cause

      • suppressed

        public final java.util.List<ErrorCause> suppressed()
        API name: suppressed

      • serialize

        public void serialize​(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)
        Serialize this object to JSON.
        Specified by:
        serialize in interface JsonpSerializable

      • serializeInternal

        protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)