Class RestClusterAllocationExplainAction

  • All Implemented Interfaces:
    RestHandler

    public class RestClusterAllocationExplainAction
    extends BaseRestHandler
    Class handling cluster allocation explanation at the REST level
    • Constructor Detail

      • RestClusterAllocationExplainAction

        public RestClusterAllocationExplainAction​(Settings settings,
                                                  RestController controller)
    • Method Detail

      • getName

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