Class RestSearchAction
- java.lang.Object
-
- org.elasticsearch.common.component.AbstractComponent
-
- org.elasticsearch.rest.BaseRestHandler
-
- org.elasticsearch.rest.action.search.RestSearchAction
-
- All Implemented Interfaces:
RestHandler
public class RestSearchAction extends BaseRestHandler
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RestChannelConsumer
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPED_KEYS_PARAM
-
Fields inherited from class org.elasticsearch.rest.BaseRestHandler
MULTI_ALLOW_EXPLICIT_INDEX
-
Fields inherited from class org.elasticsearch.common.component.AbstractComponent
logger
-
-
Constructor Summary
Constructors Constructor Description RestSearchAction(Settings settings, RestController controller)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
static void
parseSearchRequest(SearchRequest searchRequest, RestRequest request, XContentParser requestContentParser, java.util.function.IntConsumer setSize)
Parses the rest request on top of the SearchRequest, preserving values that are not overridden by the rest request.BaseRestHandler.RestChannelConsumer
prepareRequest(RestRequest request, NodeClient client)
Prepare the request for execution.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 inBaseRestHandler.prepareRequest(RestRequest, NodeClient)
.-
Methods inherited from class org.elasticsearch.rest.BaseRestHandler
getUsageCount, handleRequest, unrecognized
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.rest.RestHandler
canTripCircuitBreaker, supportsContentStream
-
-
-
-
Field Detail
-
TYPED_KEYS_PARAM
public static final java.lang.String TYPED_KEYS_PARAM
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RestSearchAction
public RestSearchAction(Settings settings, RestController controller)
-
-
Method Detail
-
getName
public java.lang.String getName()
- Specified by:
getName
in 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 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 overrideBaseRestHandler.responseParams()
to indicate such params.- Specified by:
prepareRequest
in classBaseRestHandler
- Parameters:
request
- the request to executeclient
- 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
-
parseSearchRequest
public static void parseSearchRequest(SearchRequest searchRequest, RestRequest request, XContentParser requestContentParser, java.util.function.IntConsumer setSize) throws java.io.IOException
Parses the rest request on top of the SearchRequest, preserving values that are not overridden by the rest request.- Parameters:
requestContentParser
- body of the request to read. This method does not attempt to read the body from therequest
parametersetSize
- how the size url parameter is handled.udpate_by_query
and regular search differ here.- Throws:
java.io.IOException
-
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 inBaseRestHandler.prepareRequest(RestRequest, NodeClient)
.- Overrides:
responseParams
in classBaseRestHandler
- Returns:
- a set of parameters used to control the response and thus should not trip strict URL parameter checks.
-
-