Package org.elasticsearch.rest.action.cat

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
public abstract class AbstractCatAction
extends BaseRestHandler

  • Constructor Details

    • AbstractCatAction

      public AbstractCatAction()

  • Method Details

    • doCatRequest

      protected abstract BaseRestHandler.RestChannelConsumer doCatRequest​(RestRequest request, NodeClient client)

    • documentation

      protected abstract void documentation​(java.lang.StringBuilder sb)

    • getTableWithHeader

      protected abstract Table getTableWithHeader​(RestRequest request)

    • prepareRequest

      public BaseRestHandler.RestChannelConsumer prepareRequest​(RestRequest request, NodeClient client) throws java.io.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 override BaseRestHandler.responseParams() to indicate such params.
      Specified by:
      prepareRequest in class BaseRestHandler
      Parameters:
      request - the request to execute
      client - client for executing actions on the local node
      Returns:
      the action to execute
      Throws:
      java.io.IOException - if an I/O exception occurred parsing the request and preparing for execution

    • 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 in BaseRestHandler.prepareRequest(RestRequest, NodeClient).
      Overrides:
      responseParams in class BaseRestHandler
      Returns:
      a set of parameters used to control the response and thus should not trip strict URL parameter checks.