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

Class RecoveryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.broadcast.BroadcastRequest<RecoveryRequest>

org.elasticsearch.action.admin.indices.recovery.RecoveryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest

public class RecoveryRequest
extends BroadcastRequest<RecoveryRequest>

Request for recovery information

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

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

DEFAULT_INDICES_OPTIONS, indices

Constructor Summary

Constructors

Constructor	Description
RecoveryRequest()	Constructs a request for recovery information for all shards
RecoveryRequest(String... indices)	Constructs a request for recovery information for all shards for the given indices
RecoveryRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	activeOnly()	True if activeOnly flag is set, false otherwise.
void	activeOnly(boolean activeOnly)	Set value of the activeOnly flag.
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	detailed()	True if detailed flag is set, false otherwise.
void	detailed(boolean detailed)	Set value of the detailed flag.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

includeDataStreams, indices, indices, indicesOptions, indicesOptions, timeout, timeout, validate

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

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.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

getDescription, setParentTask

Constructor Details

RecoveryRequest

public RecoveryRequest()

Constructs a request for recovery information for all shards

RecoveryRequest

public RecoveryRequest(StreamInput in)
                throws IOException

Throws:

IOException

RecoveryRequest

public RecoveryRequest(String... indices)

Constructs a request for recovery information for all shards for the given indices

Parameters:

indices - Comma-separated list of indices about which to gather recovery information

Method Details

detailed

public boolean detailed()

True if detailed flag is set, false otherwise. This value if false by default.

Returns:

True if detailed flag is set, false otherwise

detailed

public void detailed(boolean detailed)

Set value of the detailed flag. Detailed requests will contain extra information such as a list of physical files and their recovery progress.

Parameters:

detailed - Whether or not to set the detailed flag

activeOnly

public boolean activeOnly()

True if activeOnly flag is set, false otherwise. This value is false by default.

Returns:

True if activeOnly flag is set, false otherwise

activeOnly

public void activeOnly(boolean activeOnly)

Set value of the activeOnly flag. If true, this request will only response with on-going recovery information.

Parameters:

activeOnly - Whether or not to set the activeOnly flag.

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 BroadcastRequest<RecoveryRequest>

Throws:

IOException

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.