org.elasticsearch.action.updatebyquery

Class UpdateByQueryResponse

java.lang.Object

org.elasticsearch.common.ContextHolder

org.elasticsearch.transport.TransportMessage<org.elasticsearch.transport.TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.updatebyquery.UpdateByQueryResponse

All Implemented Interfaces:

org.elasticsearch.common.io.stream.Streamable

public class UpdateByQueryResponse
extends org.elasticsearch.action.ActionResponse

Encapsulates the result of an update by query request by bundling all bulk item responses. Each bulk item response holds the result of an individual update.

Nested Class Summary

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

org.elasticsearch.transport.TransportResponse.Empty

Constructor Summary

Constructors

Constructor and Description
UpdateByQueryResponse(long tookInMillis, IndexUpdateByQueryResponse... indexResponses)

Method Summary

Methods

Modifier and Type	Method and Description
IndexUpdateByQueryResponse[]	getIndexResponses()
String[]	getMainFailures()
long	getTookInMillis()
long	getTotalHits()
long	getUpdated()
boolean	hasFailures()
IndexUpdateByQueryResponse[]	indexResponses()
UpdateByQueryResponse	indexResponses(IndexUpdateByQueryResponse[] responses)
String[]	mainFailures()
UpdateByQueryResponse	mainFailures(String[] mainFailures)
void	readFrom(org.elasticsearch.common.io.stream.StreamInput in)
long	tookInMillis()
long	totalHits()
long	updated()
void	writeTo(org.elasticsearch.common.io.stream.StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

getHeader, getHeaders, hasHeader, putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextHolder

contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateByQueryResponse

public UpdateByQueryResponse(long tookInMillis,
                     IndexUpdateByQueryResponse... indexResponses)

Method Detail

tookInMillis

public long tookInMillis()

getTookInMillis

public long getTookInMillis()

indexResponses

public IndexUpdateByQueryResponse[] indexResponses()

getIndexResponses

public IndexUpdateByQueryResponse[] getIndexResponses()

indexResponses

public UpdateByQueryResponse indexResponses(IndexUpdateByQueryResponse[] responses)

mainFailures

public String[] mainFailures()

Returns:

The main index level failures

getMainFailures

public String[] getMainFailures()

mainFailures

public UpdateByQueryResponse mainFailures(String[] mainFailures)

totalHits

public long totalHits()

Returns:

the number of documents that have matched with the update query

getTotalHits

public long getTotalHits()

updated

public long updated()

Returns:

the number of documents that are actually updated

getUpdated

public long getUpdated()

hasFailures

public boolean hasFailures()

readFrom

public void readFrom(org.elasticsearch.common.io.stream.StreamInput in)
              throws IOException

Specified by:

readFrom in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

readFrom in class org.elasticsearch.action.ActionResponse

Throws:

IOException

writeTo

public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

writeTo in class org.elasticsearch.action.ActionResponse

Throws:

IOException