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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RestChannelConsumer
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.rest.BaseRestHandler
MULTI_ALLOW_EXPLICIT_INDEX
-
Fields inherited from class org.elasticsearch.common.component.AbstractComponent
logger
-
-
Constructor Summary
Constructors Constructor Description RestRecoveryAction(Settings settings, RestController restController)
-
Method Summary
All Methods Instance Methods Concrete Methods 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(java.lang.StringBuilder sb)
java.lang.String
getName()
protected Table
getTableWithHeader(RestRequest request)
-
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
canTripCircuitBreaker, supportsContentStream
-
-
-
-
Constructor Detail
-
RestRecoveryAction
public RestRecoveryAction(Settings settings, RestController restController)
-
-
Method Detail
-
getName
public java.lang.String getName()
- Specified by:
getName
in classBaseRestHandler
- 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(java.lang.StringBuilder sb)
- Specified by:
documentation
in classAbstractCatAction
-
doCatRequest
public BaseRestHandler.RestChannelConsumer doCatRequest(RestRequest request, NodeClient client)
- Specified by:
doCatRequest
in classAbstractCatAction
-
getTableWithHeader
protected Table getTableWithHeader(RestRequest request)
- Specified by:
getTableWithHeader
in classAbstractCatAction
-
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 requestresponse
- A recovery status response- Returns:
- A table containing index, shardId, node, target size, recovered size and percentage for each recovering replica
-
-