java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.bulk.BulkResponse
- All Implemented Interfaces:
Iterable<BulkItemResponse>,Writeable,ChunkedToXContent,ChunkedToXContentObject,RefCounted
public class BulkResponse
extends ActionResponse
implements Iterable<BulkItemResponse>, ChunkedToXContentObject
A response of a bulk execution. Holding a response for each item responding (in order) of the
bulk requests. Each item holds the index/type/id is operated on, and if it failed or not (with the
failure message).
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse
ActionResponse.EmptyNested 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.common.xcontent.ChunkedToXContent
EMPTYFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
ConstructorsConstructorDescriptionBulkResponse(BulkItemResponse[] responses, long tookInMillis) BulkResponse(BulkItemResponse[] responses, long tookInMillis, long ingestTookInMillis) BulkResponse(BulkItemResponse[] responses, long tookInMillis, long ingestTookInMillis, org.elasticsearch.action.bulk.BulkRequest.IncrementalState incrementalState) -
Method Summary
Modifier and TypeMethodDescriptionIf ingest is enabled returns the bulk ingest preprocessing time, otherwise 0 is returned.longIf ingest is enabled returns the bulk ingest preprocessing time.getItems()The items representing each action performed in the bulk operation (in the same order!).getTook()How long the bulk execution took.longbooleanHas anything failed with the execution.iterator()Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params) Create an iterator ofToXContentchunks for a REST response.voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRefMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent
toXContentChunked, toXContentChunkedV8Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject
isFragmentMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.elasticsearch.core.RefCounted
mustIncRef
-
Field Details
-
NO_INGEST_TOOK
public static final long NO_INGEST_TOOK- See Also:
-
-
Constructor Details
-
BulkResponse
- Throws:
IOException
-
BulkResponse
-
BulkResponse
-
BulkResponse
public BulkResponse(BulkItemResponse[] responses, long tookInMillis, long ingestTookInMillis, org.elasticsearch.action.bulk.BulkRequest.IncrementalState incrementalState)
-
-
Method Details
-
getTook
How long the bulk execution took. Excluding ingest preprocessing. -
getTookInMillis
public long getTookInMillis() -
getIngestTook
If ingest is enabled returns the bulk ingest preprocessing time, otherwise 0 is returned. -
getIngestTookInMillis
public long getIngestTookInMillis()If ingest is enabled returns the bulk ingest preprocessing time. in milliseconds, otherwise -1 is returned. -
hasFailures
public boolean hasFailures()Has anything failed with the execution. -
buildFailureMessage
-
getItems
The items representing each action performed in the bulk operation (in the same order!). -
iterator
- Specified by:
iteratorin interfaceIterable<BulkItemResponse>
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContentChunked
Description copied from interface:ChunkedToXContentCreate an iterator ofToXContentchunks for a REST response. Each chunk is serialized with the sameXContentBuilderandToXContent.Params, which is also the same as theToXContent.Paramspassed as theparamsargument. For best results, all chunks should beO(1)size. The last chunk in the iterator must always yield at least one byte of output. See alsoChunkedToXContentHelperfor some handy utilities.Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.
- Specified by:
toXContentChunkedin interfaceChunkedToXContent- Returns:
- iterator over chunks of
ToXContent
-