Module org.elasticsearch.server

Package org.elasticsearch.action.bulk

Class BulkResponse

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.Empty

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 long	NO_INGEST_TOOK

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

EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
BulkResponse(BulkItemResponse[] responses, long tookInMillis)
BulkResponse(BulkItemResponse[] responses, long tookInMillis, long ingestTookInMillis)
BulkResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	buildFailureMessage()
TimeValue	getIngestTook()	If ingest is enabled returns the bulk ingest preprocessing time, otherwise 0 is returned.
long	getIngestTookInMillis()	If ingest is enabled returns the bulk ingest preprocessing time.
BulkItemResponse[]	getItems()	The items representing each action performed in the bulk operation (in the same order!).
TimeValue	getTook()	How long the bulk execution took.
boolean	hasFailures()	Has anything failed with the execution.
Iterator<BulkItemResponse>	iterator()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

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

toXContentChunkedV7

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

isFragment

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

NO_INGEST_TOOK

public static final long NO_INGEST_TOOK

See Also:

• Constant Field Values

Constructor Details

BulkResponse

public BulkResponse(StreamInput in)
             throws IOException

Throws:

IOException

BulkResponse

public BulkResponse(BulkItemResponse[] responses,
 long tookInMillis)

BulkResponse

public BulkResponse(BulkItemResponse[] responses,
 long tookInMillis,
 long ingestTookInMillis)

Method Details

getTook

public TimeValue getTook()

How long the bulk execution took. Excluding ingest preprocessing.

getIngestTook

public TimeValue 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

public String buildFailureMessage()

getItems

public BulkItemResponse[] getItems()

The items representing each action performed in the bulk operation (in the same order!).

iterator

public Iterator<BulkItemResponse> iterator()

Specified by:

iterator in interface Iterable<BulkItemResponse>

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

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for 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:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent