java.lang.Object
org.elasticsearch.action.bulk.BulkItemResponse
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentObject
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 in case it failed).
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptionstatic BulkItemResponsefailure(int id, DocWriteRequest.OpType opType, BulkItemResponse.Failure failure) The actual failure object if there was a failure.The failure message,nullif it did not fail.getId()The id of the action.getIndex()The index name of the action.intThe numeric order of the item matching the same request order in the bulk request.The operation type ("index", "create" or "delete").<T extends DocWriteResponse>
TThe actual response (IndexResponseorDeleteResponse).longThe version of the action.booleanisFailed()Is this a failed execution of an operation.status()static BulkItemResponsesuccess(int id, DocWriteRequest.OpType opType, DocWriteResponse response) toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
THIN_WRITER
-
-
Method Details
-
status
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
success
public static BulkItemResponse success(int id, DocWriteRequest.OpType opType, DocWriteResponse response) -
failure
public static BulkItemResponse failure(int id, DocWriteRequest.OpType opType, BulkItemResponse.Failure failure) -
getItemId
public int getItemId()The numeric order of the item matching the same request order in the bulk request. -
getOpType
The operation type ("index", "create" or "delete"). -
getIndex
The index name of the action. -
getId
The id of the action. -
getVersion
public long getVersion()The version of the action. -
getFailureStoreStatus
-
getResponse
-
isFailed
public boolean isFailed()Is this a failed execution of an operation. -
getFailureMessage
The failure message,nullif it did not fail. -
getFailure
The actual failure object if there was a failure. -
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-