org.elasticsearch.action.support.broadcast

Class BroadcastOperationResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BroadcastOperationResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

Direct Known Subclasses:

ClearIndicesCacheResponse, CountResponse, ExistsResponse, FieldStatsResponse, FlushResponse, IndicesSegmentResponse, IndicesStatsResponse, IndicesStatusResponse, OptimizeResponse, PercolateResponse, RecoveryResponse, RefreshResponse, SuggestResponse, UpgradeResponse, UpgradeStatusResponse, ValidateQueryResponse

public abstract class BroadcastOperationResponse
extends ActionResponse

Base class for all broadcast operation based responses.

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

Modifier	Constructor and Description
protected	BroadcastOperationResponse()
protected	BroadcastOperationResponse(int totalShards, int successfulShards, int failedShards, List<ShardOperationFailedException> shardFailures)

Method Summary

Modifier and Type	Method and Description
int	getFailedShards() The failed shards this request was executed on.
ShardOperationFailedException[]	getShardFailures() The list of shard failures exception.
int	getSuccessfulShards() The successful shards this request was executed on.
int	getTotalShards() The total shards this request ran against.
void	readFrom(StreamInput in)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BroadcastOperationResponse

protected BroadcastOperationResponse()

BroadcastOperationResponse

protected BroadcastOperationResponse(int totalShards,
                                     int successfulShards,
                                     int failedShards,
                                     List<ShardOperationFailedException> shardFailures)

Method Detail

getTotalShards

public int getTotalShards()

The total shards this request ran against.

getSuccessfulShards

public int getSuccessfulShards()

The successful shards this request was executed on.

getFailedShards

public int getFailedShards()

The failed shards this request was executed on.

getShardFailures

public ShardOperationFailedException[] getShardFailures()

The list of shard failures exception.

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