Class AbstractCatAction
java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.rest.action.cat.AbstractCatAction
- All Implemented Interfaces:
RestHandler
- Direct Known Subclasses:
RestAliasAction
,RestAllocationAction
,RestCatRecoveryAction
,RestCountAction
,RestFielddataAction
,RestHealthAction
,RestIndicesAction
,RestMasterAction
,RestNodeAttrsAction
,RestNodesAction
,RestPendingClusterTasksAction
,RestPluginsAction
,RestRepositoriesAction
,RestSegmentsAction
,RestShardsAction
,RestSnapshotAction
,RestTasksAction
,RestTemplatesAction
,RestThreadPoolAction
-
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, MULTI_ALLOW_EXPLICIT_INDEX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract BaseRestHandler.RestChannelConsumer
doCatRequest
(RestRequest request, NodeClient client) protected abstract void
protected abstract Table
getTableWithHeader
(RestRequest request) prepareRequest
(RestRequest request, NodeClient client) Prepare the request for execution.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.BaseRestHandler
getName, getUsageCount, handleRequest, responseParams, routes, 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, validAcceptMediaTypes
-
Constructor Details
-
AbstractCatAction
public AbstractCatAction()
-
-
Method Details
-
doCatRequest
protected abstract BaseRestHandler.RestChannelConsumer doCatRequest(RestRequest request, NodeClient client) -
documentation
-
getTableWithHeader
-
prepareRequest
public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException Description copied from class:BaseRestHandler
Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can overrideBaseRestHandler.responseParams()
to indicate such params.- Specified by:
prepareRequest
in classBaseRestHandler
- Parameters:
request
- the request to executeclient
- client for executing actions on the local node- Returns:
- the action to execute
- Throws:
IOException
- if an I/O exception occurred parsing the request and preparing for execution
-
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 classBaseRestHandler
- Returns:
- a set of parameters used to control the response and thus should not trip strict URL parameter checks.
-