org.elasticsearch.action.bulk

Class BulkResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.bulk.BulkResponse

All Implemented Interfaces:

Iterable<BulkItemResponse>, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class BulkResponse
extends ActionResponse
implements Iterable<BulkItemResponse>

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.transport.TransportResponse

TransportResponse.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
BulkResponse(BulkItemResponse[] responses, long tookInMillis)

Method Summary

Methods

Modifier and Type	Method and Description
String	buildFailureMessage()
BulkItemResponse[]	getItems() The items representing each action performed in the bulk operation (in the same order!).
TimeValue	getTook() How long the bulk execution took.
long	getTookInMillis() How long the bulk execution took in milliseconds.
boolean	hasFailures() Has anything failed with the execution.
Iterator<BulkItemResponse>	iterator()
void	readFrom(StreamInput in)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkResponse

public BulkResponse(BulkItemResponse[] responses,
            long tookInMillis)

Method Detail

getTook

public TimeValue getTook()

How long the bulk execution took.

getTookInMillis

public long getTookInMillis()

How long the bulk execution took in milliseconds.

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>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException