Package org.opensearch.rest.action.search

Class RestMultiSearchAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.rest.action.search.RestMultiSearchAction

All Implemented Interfaces:

RestHandler

public class RestMultiSearchAction
extends BaseRestHandler

Transport action to perform a multi 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 inherited from class org.opensearch.rest.BaseRestHandler

DUPLICATE_PARAMETER_ERROR_MESSAGE, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestMultiSearchAction(Settings settings)

Method Summary

Modifier and Type	Method	Description
String	getName()
static void	parseMultiLineRequest(RestRequest request, IndicesOptions indicesOptions, boolean allowExplicitIndex, CheckedBiConsumer<SearchRequest,org.opensearch.common.xcontent.XContentParser,IOException> consumer)	Parses a multi-line RestRequest body, instantiating a SearchRequest for each line and applying the given consumer.
static MultiSearchRequest	parseRequest(RestRequest restRequest, NamedWriteableRegistry namedWriteableRegistry, boolean allowExplicitIndex)	Parses a RestRequest body and returns a MultiSearchRequest
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.
boolean	supportsContentStream()	Indicates if the RestHandler supports content as a stream.

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

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes

Constructor Details

RestMultiSearchAction

public RestMultiSearchAction(Settings settings)

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

parseRequest

public static MultiSearchRequest parseRequest(RestRequest restRequest,
 NamedWriteableRegistry namedWriteableRegistry,
 boolean allowExplicitIndex)
                                       throws IOException

Parses a RestRequest body and returns a MultiSearchRequest

Throws:

IOException

parseMultiLineRequest

public static void parseMultiLineRequest(RestRequest request,
 IndicesOptions indicesOptions,
 boolean allowExplicitIndex,
 CheckedBiConsumer<SearchRequest,org.opensearch.common.xcontent.XContentParser,IOException> consumer)
                                  throws IOException

Parses a multi-line RestRequest body, instantiating a SearchRequest for each line and applying the given consumer.

Throws:

IOException

supportsContentStream

public boolean supportsContentStream()

Description copied from interface: RestHandler

Indicates if the RestHandler supports content as a stream. A stream would be multiple objects delineated by XContent.streamSeparator(). If a handler returns true this will affect the types of content that can be sent to this endpoint.

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.