Class RecoveryResponse
java.lang.Object
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
,ToXContent
,ToXContentObject
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.transport.TransportResponse
TransportResponse.Empty
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
-
Constructor Summary
Constructors Constructor Description RecoveryResponse(int totalShards, int successfulShards, int failedShards, java.util.Map<java.lang.String,java.util.List<RecoveryState>> shardRecoveryStates, java.util.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()
java.util.Map<java.lang.String,java.util.List<RecoveryState>>
shardRecoveryStates()
java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, 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
remoteAddress, remoteAddress
-
Constructor Details
-
RecoveryResponse
- Throws:
java.io.IOException
-
RecoveryResponse
public RecoveryResponse(int totalShards, int successfulShards, int failedShards, java.util.Map<java.lang.String,java.util.List<RecoveryState>> shardRecoveryStates, java.util.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 seensuccessfulShards
- Count of shards successfully processedfailedShards
- Count of shards which failed to processshardRecoveryStates
- Map of indices to shard recovery informationshardFailures
- List of failures processing shards
-
-
Method Details
-
hasRecoveries
public boolean hasRecoveries() -
shardRecoveryStates
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Overrides:
toXContent
in classBroadcastResponse
- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classBroadcastResponse
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-