org.elasticsearch.rest.action.cat

Class RestRecoveryAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.cat.AbstractCatAction

org.elasticsearch.rest.action.cat.RestRecoveryAction

All Implemented Interfaces:

RestHandler

public class RestRecoveryAction
extends AbstractCatAction

RestRecoveryAction provides information about the status of replica recovery in a string format, designed to be used at the command line. An Index can be specified to limit output to a particular index or indices.

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

parseFieldMatcher

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RestRecoveryAction(Settings settings, RestController restController, RestController controller, Client client)

Method Summary

Methods

Modifier and Type	Method and Description
Table	buildRecoveryTable(RestRequest request, RecoveryResponse response) buildRecoveryTable will build a table of recovery information suitable for displaying at the command line.
protected void	documentation(StringBuilder sb)
void	doRequest(RestRequest request, RestChannel channel, Client client)
protected Table	getTableWithHeader(RestRequest request)

Methods inherited from class org.elasticsearch.rest.action.cat.AbstractCatAction

handleRequest

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

canTripCircuitBreaker, handleRequest

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRecoveryAction

@Inject
public RestRecoveryAction(Settings settings,
                         RestController restController,
                         RestController controller,
                         Client client)

Method Detail

documentation

protected void documentation(StringBuilder sb)

Specified by:

documentation in class AbstractCatAction

doRequest

public void doRequest(RestRequest request,
             RestChannel channel,
             Client client)

Specified by:

doRequest in class AbstractCatAction

getTableWithHeader

protected Table getTableWithHeader(RestRequest request)

Specified by:

getTableWithHeader in class AbstractCatAction

buildRecoveryTable

public Table buildRecoveryTable(RestRequest request,
                       RecoveryResponse response)

buildRecoveryTable will build a table of recovery information suitable for displaying at the command line.

Parameters:

request - A Rest request

response - A recovery status response

Returns:

A table containing index, shardId, node, target size, recovered size and percentage for each recovering replica