Module org.elasticsearch.server

Package org.elasticsearch.action.support.broadcast

Class BaseBroadcastResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

All Implemented Interfaces:

Writeable, RefCounted

Direct Known Subclasses:

BroadcastResponse, ChunkedBroadcastResponse, RecoveryResponse

public class BaseBroadcastResponse
extends ActionResponse

Base class for all broadcast operation based responses.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultShardOperationFailedException[]	EMPTY

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
BaseBroadcastResponse(int totalShards, int successfulShards, int failedShards, List<DefaultShardOperationFailedException> shardFailures)
BaseBroadcastResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static <T extends BaseBroadcastResponse> void	declareBroadcastFields(ConstructingObjectParser<T,Void> PARSER)
int	getFailedShards()	The failed shards this request was executed on.
DefaultShardOperationFailedException[]	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	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Field Details

EMPTY

public static final DefaultShardOperationFailedException[] EMPTY

Constructor Details

BaseBroadcastResponse

public BaseBroadcastResponse(StreamInput in)
                      throws IOException

Throws:

IOException

BaseBroadcastResponse

public BaseBroadcastResponse(int totalShards,
 int successfulShards,
 int failedShards,
 List<DefaultShardOperationFailedException> shardFailures)

Method Details

declareBroadcastFields

public static <T extends BaseBroadcastResponse>
void declareBroadcastFields(ConstructingObjectParser<T,Void> PARSER)

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 DefaultShardOperationFailedException[] getShardFailures()

The list of shard failures exception.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

IOException