Class RestIndicesAction
- java.lang.Object
-
- org.elasticsearch.common.component.AbstractComponent
-
- org.elasticsearch.rest.BaseRestHandler
-
- org.elasticsearch.rest.action.cat.AbstractCatAction
-
- org.elasticsearch.rest.action.cat.RestIndicesAction
-
- All Implemented Interfaces:
RestHandler
public class RestIndicesAction extends AbstractCatAction
-
-
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 RestIndicesAction(Settings settings, RestController controller, IndexNameExpressionResolver indexNameExpressionResolver)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BaseRestHandler.RestChannelConsumer
doCatRequest(RestRequest request, NodeClient client)
protected void
documentation(java.lang.StringBuilder sb)
java.lang.String
getName()
protected Table
getTableWithHeader(RestRequest request)
protected java.util.Set<java.lang.String>
responseParams()
Parameters used for controlling the response and thus might not be consumed during preparation of the request execution inBaseRestHandler.prepareRequest(RestRequest, NodeClient)
.-
Methods inherited from class org.elasticsearch.rest.action.cat.AbstractCatAction
prepareRequest
-
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
-
RestIndicesAction
public RestIndicesAction(Settings settings, RestController controller, IndexNameExpressionResolver indexNameExpressionResolver)
-
-
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
-
responseParams
protected java.util.Set<java.lang.String> responseParams()
Description copied from class:BaseRestHandler
Parameters used for controlling the response and thus might not be consumed during preparation of the request execution inBaseRestHandler.prepareRequest(RestRequest, NodeClient)
.- Overrides:
responseParams
in classAbstractCatAction
- Returns:
- a set of parameters used to control the response and thus should not trip strict URL parameter checks.
-
getTableWithHeader
protected Table getTableWithHeader(RestRequest request)
- Specified by:
getTableWithHeader
in classAbstractCatAction
-
-