RestHandler
public class RestSearchAction extends BaseRestHandler
BaseRestHandler.RestChannelConsumer
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
TYPED_KEYS_PARAM |
deprecationLogger, logger, settings
MULTI_ALLOW_EXPLICIT_INDEX
Constructor | Description |
---|---|
RestSearchAction(Settings settings,
RestController controller) |
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 in
BaseRestHandler.prepareRequest(RestRequest, NodeClient) . |
logDeprecatedSetting, logRemovedSetting, nodeName
getUsageCount, handleRequest, unrecognized
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
canTripCircuitBreaker, supportsContentStream
public static final java.lang.String TYPED_KEYS_PARAM
public RestSearchAction(Settings settings, RestController controller)
public java.lang.String getName()
getName
in class BaseRestHandler
RestNodesUsageAction
.public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws java.io.IOException
BaseRestHandler
BaseRestHandler.responseParams()
to indicate such
params.prepareRequest
in class BaseRestHandler
request
- the request to executeclient
- client for executing actions on the local nodejava.io.IOException
- if an I/O exception occurred parsing the request and preparing for
executionpublic static void parseSearchRequest(SearchRequest searchRequest, RestRequest request, XContentParser requestContentParser, java.util.function.IntConsumer setSize) throws java.io.IOException
requestContentParser
- body of the request to read. This method does not attempt to read the body from the request
parametersetSize
- how the size url parameter is handled. udpate_by_query
and regular search differ here.java.io.IOException
protected java.util.Set<java.lang.String> responseParams()
BaseRestHandler
BaseRestHandler.prepareRequest(RestRequest, NodeClient)
.responseParams
in class BaseRestHandler