Package org.elasticsearch.rest.action.cat

Class RestCatRecoveryAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.cat.AbstractCatAction

org.elasticsearch.rest.action.cat.RestCatRecoveryAction

All Implemented Interfaces:

RestHandler

public class RestCatRecoveryAction
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.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer, BaseRestHandler.Wrapper

Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler

RestHandler.Route

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestCatRecoveryAction()

Method Summary

Modifier and Type	Method	Description
Table	buildRecoveryTable(RestRequest request, RecoveryResponse response)	buildRecoveryTable will build a table of recovery information suitable for displaying at the command line.
BaseRestHandler.RestChannelConsumer	doCatRequest(RestRequest request, NodeClient client)
protected void	documentation(StringBuilder sb)
String	getName()
protected Table	getTableWithHeader(RestRequest request)
List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.

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

prepareRequest, responseParams

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, unrecognized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, supportsContentStream

Constructor Details

RestCatRecoveryAction

public RestCatRecoveryAction()

Method Details

routes

public List<RestHandler.Route> routes()

Description copied from class: BaseRestHandler

The list of RestHandler.Routes that this RestHandler is responsible for handling.

Specified by:

routes in interface RestHandler

Specified by:

routes in class BaseRestHandler

getName

public String getName()

Specified by:

getName in class BaseRestHandler

Returns:

the name of this handler. The name should be human readable and should describe the action that will performed when this API is called. This name is used in the response to the RestNodesUsageAction.

documentation

protected void documentation(StringBuilder sb)

Specified by:

documentation in class AbstractCatAction

doCatRequest

public BaseRestHandler.RestChannelConsumer doCatRequest(RestRequest request,
 NodeClient client)

Specified by:

doCatRequest 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