Class RestGetIndicesAction

  • All Implemented Interfaces:

    public class RestGetIndicesAction
    extends BaseRestHandler
    The REST handler for get index and head index APIs.
    • Field Detail


        public static final java.lang.String TYPES_DEPRECATION_MESSAGE
        See Also:
        Constant Field Values
    • Constructor Detail

      • RestGetIndicesAction

        public RestGetIndicesAction​(RestController controller)
    • Method Detail

      • getName

        public java.lang.String getName()
        Specified by:
        getName in class BaseRestHandler
        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.
      • prepareRequest

        public BaseRestHandler.RestChannelConsumer prepareRequest​(RestRequest request,
                                                                  NodeClient client)
        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
        request - the request to execute
        client - client for executing actions on the local node
        the action to execute
        Throws: - if an I/O exception occurred parsing the request and preparing for execution
      • responseParams

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