org.elasticsearch.action.admin.indices.recovery

Class ShardRecoveryResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.support.broadcast.BroadcastShardOperationResponse

org.elasticsearch.action.admin.indices.recovery.ShardRecoveryResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class ShardRecoveryResponse
extends BroadcastShardOperationResponse
implements ToXContent

Information regarding the recovery state of a shard.

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
ShardRecoveryResponse()

Method Summary

Modifier and Type	Method and Description
void	readFrom(StreamInput in)
static ShardRecoveryResponse	readShardRecoveryResponse(StreamInput in) Builds a new ShardRecoveryResponse from the give input stream.
RecoveryState	recoveryState() Gets the recovery state information for the shard.
void	recoveryState(RecoveryState recoveryState) Sets the recovery state information for the shard.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

getIndex, getShardId

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardRecoveryResponse

public ShardRecoveryResponse()

Method Detail

recoveryState

public void recoveryState(RecoveryState recoveryState)

Sets the recovery state information for the shard.

Parameters:

recoveryState - Recovery state

recoveryState

@Nullable
public RecoveryState recoveryState()

Gets the recovery state information for the shard. Null if shard wasn't recovered / recovery didn't start yet.

Returns:

Recovery state

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 BroadcastShardOperationResponse

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastShardOperationResponse

Throws:

IOException

readShardRecoveryResponse

public static ShardRecoveryResponse readShardRecoveryResponse(StreamInput in)
                                                       throws IOException

Builds a new ShardRecoveryResponse from the give input stream.

Parameters:

in - Input stream

Returns:

A new ShardRecoveryResponse

Throws:

IOException