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

Class RecoveryResponse

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.broadcast.BroadcastResponse

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

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted

public class RecoveryResponse
extends BroadcastResponse

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.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

EMPTY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RecoveryResponse(int totalShards, int successfulShards, int failedShards, <,<RecoveryState>> shardRecoveryStates, <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()
<,<RecoveryState>>	shardRecoveryStates()
	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

addCustomXContentFields, declareBroadcastFields, getFailedShards, getShardFailures, getStatus, getSuccessfulShards, getTotalShards

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.

, , , , , , , , ,

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

isFragment

Constructor Details

RecoveryResponse

public RecoveryResponse(StreamInput in)
                 throws 

Throws:

RecoveryResponse

public RecoveryResponse(int totalShards,
 int successfulShards,
 int failedShards,
 <,<RecoveryState>> shardRecoveryStates,
 <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 <,<RecoveryState>> shardRecoveryStates()

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws 

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Overrides:

toXContent in class BroadcastResponse

Throws:

writeTo

public void writeTo(StreamOutput out)
             throws 

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BroadcastResponse

Throws:

toString

public  toString()

Overrides:

in class