Package org.elasticsearch.action.support.broadcast

Class BroadcastResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BroadcastResponse

All Implemented Interfaces:

Streamable, Writeable

Direct Known Subclasses:

ClearIndicesCacheResponse, FlushResponse, ForceMergeResponse, IndicesSegmentResponse, IndicesStatsResponse, RecoveryResponse, RefreshResponse, UpgradeResponse, UpgradeStatusResponse, ValidateQueryResponse

public class BroadcastResponse
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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
BroadcastResponse()
BroadcastResponse(int totalShards, int successfulShards, int failedShards, java.util.List<? extends ShardOperationFailedException> shardFailures)

Method Summary

Modifier and Type	Method	Description
int	getFailedShards()	The failed shards this request was executed on.
ShardOperationFailedException[]	getShardFailures()	The list of shard failures exception.
RestStatus	getStatus()	The REST status that should be used for the response
int	getSuccessfulShards()	The successful shards this request was executed on.
int	getTotalShards()	The total shards this request ran against.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

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.io.stream.Streamable

newWriteableReader

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Constructor Detail

BroadcastResponse

public BroadcastResponse()

BroadcastResponse

public BroadcastResponse(int totalShards,
                         int successfulShards,
                         int failedShards,
                         java.util.List<? extends 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.

getStatus

public RestStatus getStatus()

The REST status that should be used for the response

getShardFailures

public ShardOperationFailedException[] getShardFailures()

The list of shard failures exception.

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.IOException