Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.recovery

Class RecoveryResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

org.elasticsearch.action.admin.indices.recovery.RecoveryResponse

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject, RefCounted

public class RecoveryResponse
extends BaseBroadcastResponse
implements ChunkedToXContentObject

Information regarding the recovery state of indices and their associated shards.

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 inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

EMPTY

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
RecoveryResponse(int totalShards, int successfulShards, int failedShards, Map<String,List<RecoveryState>> shardRecoveryStates, List<DefaultShardOperationFailedException> shardFailures)	Constructs recovery information for a collection of indices and associated shards.
RecoveryResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	hasRecoveries()
Map<String,List<RecoveryState>>	shardRecoveryStates()
String	toString()
Iterator<ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.broadcast.BaseBroadcastResponse

declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards

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, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

toXContentChunkedV7

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Constructor Details

RecoveryResponse

public RecoveryResponse(StreamInput in)
                 throws IOException

Throws:

IOException

RecoveryResponse

public RecoveryResponse(int totalShards,
 int successfulShards,
 int failedShards,
 Map<String,List<RecoveryState>> shardRecoveryStates,
 List<DefaultShardOperationFailedException> shardFailures)

Constructs recovery information for a collection of indices and associated shards. Keeps track of how many total shards were seen, and out of those how many were successfully processed and how many failed.

Parameters:

totalShards - Total count of shards seen

successfulShards - Count of shards successfully processed

failedShards - Count of shards which failed to process

shardRecoveryStates - Map of indices to shard recovery information

shardFailures - List of failures processing shards

Method Details

hasRecoveries

public boolean hasRecoveries()

shardRecoveryStates

public Map<String,List<RecoveryState>> shardRecoveryStates()

toXContentChunked

public Iterator<ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseBroadcastResponse

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object