org.elasticsearch.action.admin.indices.recovery

Class RecoveryResponse

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.BroadcastResponse

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

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class RecoveryResponse
extends BroadcastResponse
implements ToXContent

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

Nested Class Summary

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

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	detailed()
void	detailed(boolean detailed)
boolean	hasRecoveries()
void	readFrom(StreamInput in)
Map<String,List<RecoveryState>>	shardRecoveryStates()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

getFailedShards, getShardFailures, getSuccessfulShards, getTotalShards

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoveryResponse

public RecoveryResponse()

RecoveryResponse

public RecoveryResponse(int totalShards,
                int successfulShards,
                int failedShards,
                boolean detailed,
                Map<String,List<RecoveryState>> shardRecoveryStates,
                List<ShardOperationFailedException> 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

detailed - Display detailed metrics

shardRecoveryStates - Map of indices to shard recovery information

shardFailures - List of failures processing shards

Method Detail

hasRecoveries

public boolean hasRecoveries()

detailed

public boolean detailed()

detailed

public void detailed(boolean detailed)

shardRecoveryStates

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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastResponse

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastResponse

Throws:

IOException