Module org.elasticsearch.server
Class RestSimulateIngestAction
java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.rest.action.ingest.RestSimulateIngestAction
- All Implemented Interfaces:
RestHandler
This is the REST endpoint for the simulate ingest API. This API executes all pipelines for a document (or documents) that would be
executed if that document were sent to the given index. The JSON that would be indexed is returned to the user, along with the list of
pipelines that were executed. The API allows the user to optionally send in substitute definitions for pipelines so that changes can be
tried out without actually modifying the cluster state.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumerNested 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetName()prepareRequest(RestRequest request, NodeClient client) Prepare the request for execution.routes()The list ofRestHandler.Routes that this RestHandler is responsible for handling.Methods inherited from class org.elasticsearch.rest.BaseRestHandler
getUsageCount, handleRequest, responseParams, responseParams, unrecognizedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.rest.RestHandler
allowSystemIndexAccessByDefault, allSupportedParameters, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportedQueryParameters, supportsBulkContent
-
Constructor Details
-
RestSimulateIngestAction
public RestSimulateIngestAction()
-
-
Method Details
-
routes
Description copied from class:BaseRestHandlerThe list ofRestHandler.Routes that this RestHandler is responsible for handling.- Specified by:
routesin interfaceRestHandler- Specified by:
routesin classBaseRestHandler
-
getName
- Specified by:
getNamein interfaceRestHandler- Specified by:
getNamein classBaseRestHandler- 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:BaseRestHandlerPrepare 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:
prepareRequestin 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
-