Package org.opensearch.rest.action.admin.indices

Class RestPutMappingAction

java.lang.Object
org.opensearch.rest.BaseRestHandler
org.opensearch.rest.action.admin.indices.RestPutMappingAction
All Implemented Interfaces:
RestHandler
public class RestPutMappingAction extends BaseRestHandler
Transport action to put mapping
Opensearch.api:

  • Constructor Details

    • RestPutMappingAction

      public RestPutMappingAction()

  • Method Details

    • routes

      public List<RestHandler.Route> routes()
      Description copied from interface: RestHandler
      The list of RestHandler.Routes that this RestHandler is responsible for handling.

    • getName

      public 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 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:
      IOException - if an I/O exception occurred parsing the request and preparing for execution