Package org.opensearch.rest.action.search

Class RestSearchAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.rest.action.search.RestSearchAction

All Implemented Interfaces:

RestHandler

public class RestSearchAction
extends BaseRestHandler

Transport action to perform a search

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer, BaseRestHandler.Wrapper

Nested classes/interfaces inherited from interface org.opensearch.rest.RestHandler

RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOTAL_HITS_AS_INT_PARAM	Indicates whether hits.total should be rendered as an integer or an object in the rest search response.
static final String	TYPED_KEYS_PARAM

Fields inherited from class org.opensearch.rest.BaseRestHandler

DUPLICATE_PARAMETER_ERROR_MESSAGE, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestSearchAction()

Method Summary

Modifier and Type	Method	Description
boolean	allowsUnsafeBuffers()	Indicates if the RestHandler supports working with pooled buffers.
static void	checkRestTotalHits(RestRequest restRequest, SearchRequest searchRequest)	Modify the search request to accurately count the total hits that match the query if TOTAL_HITS_AS_INT_PARAM is set.
String	getName()
static void	parseSearchRequest(SearchRequest searchRequest, RestRequest request, org.opensearch.common.xcontent.XContentParser requestContentParser, NamedWriteableRegistry namedWriteableRegistry, 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 Set<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).
List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.

Methods inherited from class org.opensearch.rest.BaseRestHandler

getUsageCount, handleRequest, parseDeprecatedMasterTimeoutParameter, unrecognized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.rest.RestHandler

allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream

Field Details

TOTAL_HITS_AS_INT_PARAM

public static final String TOTAL_HITS_AS_INT_PARAM

Indicates whether hits.total should be rendered as an integer or an object in the rest search response.

See Also:

• Constant Field Values

TYPED_KEYS_PARAM

public static final String TYPED_KEYS_PARAM

See Also:

• Constant Field Values

Constructor Details

RestSearchAction

public RestSearchAction()

Method Details

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.

routes

public List<RestHandler.Route> routes()

Description copied from interface: RestHandler

The list of RestHandler.Routes that this RestHandler is responsible for handling.

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

parseSearchRequest

public static void parseSearchRequest(SearchRequest searchRequest,
 RestRequest request,
 org.opensearch.common.xcontent.XContentParser requestContentParser,
 NamedWriteableRegistry namedWriteableRegistry,
 IntConsumer setSize)
                               throws 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 the request parameter

setSize - how the size url parameter is handled. udpate_by_query and regular search differ here.

Throws:

IOException

checkRestTotalHits

public static void checkRestTotalHits(RestRequest restRequest,
 SearchRequest searchRequest)

Modify the search request to accurately count the total hits that match the query if TOTAL_HITS_AS_INT_PARAM is set.

Throws:

IllegalArgumentException - if TOTAL_HITS_AS_INT_PARAM is used in conjunction with a lower bound value (other than SearchContext.DEFAULT_TRACK_TOTAL_HITS_UP_TO) for the track_total_hits option.

responseParams

protected Set<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 in BaseRestHandler.prepareRequest(RestRequest, NodeClient).

Overrides:

responseParams in class BaseRestHandler

Returns:

a set of parameters used to control the response and thus should not trip strict URL parameter checks.

allowsUnsafeBuffers

public boolean allowsUnsafeBuffers()

Description copied from interface: RestHandler

Indicates if the RestHandler supports working with pooled buffers. If the request handler will not escape the return RestRequest.content() or any buffers extracted from it then there is no need to make a copies of any pooled buffers in the RestRequest instance before passing a request to this handler. If this instance does not support pooled/unsafe buffers RestRequest.ensureSafeBuffers() should be called on any request before passing it to RestHandler.handleRequest(org.opensearch.rest.RestRequest, org.opensearch.rest.RestChannel, org.opensearch.client.node.NodeClient).

Returns:

true iff the handler supports requests that make use of pooled buffers