org.elasticsearch.index.reindex

Class BulkIndexByScrollResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.index.reindex.BulkIndexByScrollResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

Direct Known Subclasses:

ReindexResponse

public class BulkIndexByScrollResponse
extends ActionResponse
implements ToXContent

Response used for actions that index many documents using a scroll request.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
BulkIndexByScrollResponse()
BulkIndexByScrollResponse(TimeValue took, BulkByScrollTask.Status status, List<BulkItemResponse.Failure> indexingFailures, List<ShardSearchFailure> searchFailures, boolean timedOut)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatches()
List<BulkItemResponse.Failure>	getIndexingFailures() All of the indexing failures.
long	getNoops()
String	getReasonCancelled() The reason that the request was canceled or null if it hasn't been.
List<ShardSearchFailure>	getSearchFailures() All search failures.
protected BulkByScrollTask.Status	getStatus()
TimeValue	getTook()
long	getUpdated()
long	getVersionConflicts()
boolean	isTimedOut() Did any of the sub-requests that were part of this request timeout?
void	readFrom(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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, wait, wait, wait

Constructor Detail

BulkIndexByScrollResponse

public BulkIndexByScrollResponse()

BulkIndexByScrollResponse

public BulkIndexByScrollResponse(TimeValue took,
                         BulkByScrollTask.Status status,
                         List<BulkItemResponse.Failure> indexingFailures,
                         List<ShardSearchFailure> searchFailures,
                         boolean timedOut)

Method Detail

getTook

public TimeValue getTook()

getStatus

protected BulkByScrollTask.Status getStatus()

getUpdated

public long getUpdated()

getBatches

public int getBatches()

getVersionConflicts

public long getVersionConflicts()

getNoops

public long getNoops()

getReasonCancelled

public String getReasonCancelled()

The reason that the request was canceled or null if it hasn't been.

getIndexingFailures

public List<BulkItemResponse.Failure> getIndexingFailures()

All of the indexing failures. Version conflicts are only included if the request sets abortOnVersionConflict to true (the default).

getSearchFailures

public List<ShardSearchFailure> getSearchFailures()

All search failures.

isTimedOut

public boolean isTimedOut()

Did any of the sub-requests that were part of this request timeout?

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object