org.elasticsearch.action.bulk

Class BulkItemResponse

java.lang.Object

org.elasticsearch.action.bulk.BulkItemResponse

All Implemented Interfaces:

Streamable

public class BulkItemResponse
extends Object
implements Streamable

Represents a single item response for an action executed as part of the bulk API. Holds the index/type/id of the relevant action, and if it has failed or not (with the failure message incase it failed).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkItemResponse.Failure Represents a failure.

Constructor Summary

Constructors

Constructor and Description
BulkItemResponse(int id, String opType, ActionWriteResponse response)
BulkItemResponse(int id, String opType, BulkItemResponse.Failure failure)

Method Summary

Methods

Modifier and Type	Method and Description
BulkItemResponse.Failure	getFailure() The actual failure object if there was a failure.
String	getFailureMessage() The failure message, null if it did not fail.
String	getId() The id of the action.
String	getIndex() The index name of the action.
int	getItemId() The numeric order of the item matching the same request order in the bulk request.
String	getOpType() The operation type ("index", "create" or "delete").
<T extends ActionWriteResponse> T	getResponse() The actual response (IndexResponse or DeleteResponse).
String	getType() The type of the action.
long	getVersion() The version of the action.
boolean	isFailed() Is this a failed execution of an operation.
static BulkItemResponse	readBulkItem(StreamInput in)
void	readFrom(StreamInput in)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkItemResponse

public BulkItemResponse(int id,
                String opType,
                ActionWriteResponse response)

BulkItemResponse

public BulkItemResponse(int id,
                String opType,
                BulkItemResponse.Failure failure)

Method Detail

getItemId

public int getItemId()

The numeric order of the item matching the same request order in the bulk request.

getOpType

public String getOpType()

The operation type ("index", "create" or "delete").

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.

getVersion

public long getVersion()

The version of the action.

getResponse

public <T extends ActionWriteResponse> T getResponse()

The actual response (IndexResponse or DeleteResponse). null in case of failure.

isFailed

public boolean isFailed()

Is this a failed execution of an operation.

getFailureMessage

public String getFailureMessage()

The failure message, null if it did not fail.

getFailure

public BulkItemResponse.Failure getFailure()

The actual failure object if there was a failure.

readBulkItem

public static BulkItemResponse readBulkItem(StreamInput in)
                                     throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException