Package org.elasticsearch.action.bulk

Class BulkItemResponse.Failure

java.lang.Object

org.elasticsearch.action.bulk.BulkItemResponse.Failure

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

Enclosing class:

BulkItemResponse

public static class BulkItemResponse.Failure
extends Object
implements Writeable, ToXContentFragment

Represents a failure.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAUSE_FIELD
static final String	ID_FIELD
static final String	INDEX_FIELD
static final ConstructingObjectParser<BulkItemResponse.Failure,Void>	PARSER
static final String	STATUS_FIELD
static final String	TYPE_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Failure(String index, String type, String id, Exception cause)	For write failures before operation was assigned a sequence number.
Failure(String index, String type, String id, Exception cause, boolean aborted)
Failure(String index, String type, String id, Exception cause, long seqNo, long term)	For write failures after operation was assigned a sequence number.
Failure(String index, String type, String id, Exception cause, RestStatus status)
Failure(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
static BulkItemResponse.Failure	fromXContent(XContentParser parser)
Exception	getCause()	The actual cause of the failure.
String	getId()	The id of the action.
String	getIndex()	The index name of the action.
String	getMessage()	The failure message.
long	getSeqNo()	The operation sequence number generated by primary NOTE: SequenceNumbers.UNASSIGNED_SEQ_NO indicates sequence number was not generated by primary
RestStatus	getStatus()	The rest status.
long	getTerm()	The operation primary term of the primary NOTE: SequenceNumbers.UNASSIGNED_PRIMARY_TERM indicates primary term was not assigned by primary
String	getType()	The type of the action.
boolean	isAborted()	Whether this failure is the result of an abort.
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.xcontent.ToXContentFragment

isFragment

Field Details

INDEX_FIELD

public static final String INDEX_FIELD

See Also:

• Constant Field Values

TYPE_FIELD

public static final String TYPE_FIELD

See Also:

• Constant Field Values

ID_FIELD

public static final String ID_FIELD

See Also:

• Constant Field Values

CAUSE_FIELD

public static final String CAUSE_FIELD

See Also:

• Constant Field Values

STATUS_FIELD

public static final String STATUS_FIELD

See Also:

• Constant Field Values

PARSER

public static final ConstructingObjectParser<BulkItemResponse.Failure,Void> PARSER

Constructor Details

Failure

public Failure(String index,
 String type,
 String id,
 Exception cause)

For write failures before operation was assigned a sequence number. use @{link Failure(String, String, String, Exception, long, long)} to record operation sequence no with failure

Failure

public Failure(String index,
 String type,
 String id,
 Exception cause,
 boolean aborted)

Failure

public Failure(String index,
 String type,
 String id,
 Exception cause,
 RestStatus status)

Failure

public Failure(String index,
 String type,
 String id,
 Exception cause,
 long seqNo,
 long term)

For write failures after operation was assigned a sequence number.

Failure

public Failure(StreamInput in)
        throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getIndex

public String getIndex()

The index name of the action.

getType

public String getType()

The type of the action.

getId

public String getId()

The id of the action.

getMessage

public String getMessage()

The failure message.

getStatus

public RestStatus getStatus()

The rest status.

getCause

public Exception getCause()

The actual cause of the failure.

getSeqNo

public long getSeqNo()

The operation sequence number generated by primary NOTE: SequenceNumbers.UNASSIGNED_SEQ_NO indicates sequence number was not generated by primary

getTerm

public long getTerm()

The operation primary term of the primary NOTE: SequenceNumbers.UNASSIGNED_PRIMARY_TERM indicates primary term was not assigned by primary

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 IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static BulkItemResponse.Failure fromXContent(XContentParser parser)

toString

public String toString()

Overrides:

toString in class Object