org.elasticsearch.action.bulk

Class BulkItemResponse.Failure

java.lang.Object

org.elasticsearch.action.bulk.BulkItemResponse.Failure

All Implemented Interfaces:

Writeable, ToXContent

Enclosing class:

BulkItemResponse

public static class BulkItemResponse.Failure
extends java.lang.Object
implements Writeable, ToXContent

Represents a failure.

Nested Class Summary

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

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Failure(StreamInput in) Read from a stream.
Failure(java.lang.String index, java.lang.String type, java.lang.String id, java.lang.Exception cause)

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getCause() The actual cause of the failure.
java.lang.String	getId() The id of the action.
java.lang.String	getIndex() The index name of the action.
java.lang.String	getMessage() The failure message.
RestStatus	getStatus() The rest status.
java.lang.String	getType() The type of the action.
boolean	isAborted() Whether this failure is the result of an abort.
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

isFragment

Constructor Detail

Failure

public Failure(java.lang.String index,
               java.lang.String type,
               java.lang.String id,
               java.lang.Exception cause)

Failure

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

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

Throws:

java.io.IOException

getIndex

public java.lang.String getIndex()

The index name of the action.

getType

public java.lang.String getType()

The type of the action.

getId

public java.lang.String getId()

The id of the action.

getMessage

public java.lang.String getMessage()

The failure message.

getStatus

public RestStatus getStatus()

The rest status.

getCause

public java.lang.Exception getCause()

The actual cause of the failure.

isAborted

public boolean isAborted()

Whether this failure is the result of an abort. If true, the request to which this failure relates should never be retried, regardless of the cause.

See Also:

BulkItemRequest.abort(String, Exception)

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object