Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class MultiSearchRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.LegacyActionRequest

org.elasticsearch.action.search.MultiSearchRequest

All Implemented Interfaces:

CompositeIndicesRequest, IndicesRequest.CrossProjectCandidate, Writeable, RefCounted, TaskAwareRequest, TransportRequest

public class MultiSearchRequest
extends LegacyActionRequest
implements CompositeIndicesRequest, IndicesRequest.CrossProjectCandidate

A multi search API request.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_CONCURRENT_SEARCH_REQUESTS_DEFAULT

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
MultiSearchRequest()
MultiSearchRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
MultiSearchRequest	add(SearchRequest request)	Add a search request to execute.
MultiSearchRequest	add(SearchRequestBuilder request)	Add a search request to execute.
boolean	allowsCrossProject()	Determines whether the request type can support cross-project processing.
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)	Returns the task object that should be used to keep track of the processing of the request.
boolean	equals(Object o)
String	getProjectRouting()
int	hashCode()
IndicesOptions	indicesOptions()
MultiSearchRequest	indicesOptions(IndicesOptions indicesOptions)
int	maxConcurrentSearchRequests()	Returns the amount of search requests specified in this multi search requests are allowed to be ran concurrently.
MultiSearchRequest	maxConcurrentSearchRequests(int maxConcurrentSearchRequests)	Sets how many search requests specified in this multi search requests are allowed to be ran concurrently.
static void	readMultiLineFormat(XContent xContent, XContentParserConfiguration parserConfig, BytesReference data, CheckedBiConsumer<SearchRequest,XContentParser,IOException> consumer, String[] indices, IndicesOptions indicesOptions, String routing, String searchType, Boolean ccsMinimizeRoundtrips, boolean allowExplicitIndex, Optional<Boolean> crossProjectEnabled, String projectRouting)
static void	readMultiLineFormat(XContent xContent, XContentParserConfiguration parserConfig, BytesReference data, CheckedBiConsumer<SearchRequest,XContentParser,IOException> consumer, String[] indices, IndicesOptions indicesOptions, String routing, String searchType, Boolean ccsMinimizeRoundtrips, boolean allowExplicitIndex, TriFunction<String,Object,SearchRequest,Boolean> extraParamParser, Optional<Boolean> crossProjectEnabled, String projectRouting)
List<SearchRequest>	requests()
void	setProjectRouting(String projectRouting)
ActionRequestValidationException	validate()
static byte[]	writeMultiLineFormat(MultiSearchRequest multiSearchRequest, XContent xContent)
static void	writeSearchRequestParams(SearchRequest request, XContentBuilder xContentBuilder)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

MAX_CONCURRENT_SEARCH_REQUESTS_DEFAULT

public static final int MAX_CONCURRENT_SEARCH_REQUESTS_DEFAULT

See Also:

• Constant Field Values

Constructor Details

MultiSearchRequest

public MultiSearchRequest()

MultiSearchRequest

public MultiSearchRequest(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

add

public MultiSearchRequest add(SearchRequestBuilder request)

Add a search request to execute. Note, the order is important, the search response will be returned in the same order as the search requests.

add

public MultiSearchRequest add(SearchRequest request)

Add a search request to execute. Note, the order is important, the search response will be returned in the same order as the search requests.

maxConcurrentSearchRequests

public int maxConcurrentSearchRequests()

Returns the amount of search requests specified in this multi search requests are allowed to be ran concurrently.

maxConcurrentSearchRequests

public MultiSearchRequest maxConcurrentSearchRequests(int maxConcurrentSearchRequests)

Sets how many search requests specified in this multi search requests are allowed to be ran concurrently.

requests

public List<SearchRequest> requests()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indicesOptions

public IndicesOptions indicesOptions()

indicesOptions

public MultiSearchRequest indicesOptions(IndicesOptions indicesOptions)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

readMultiLineFormat

public static void readMultiLineFormat(XContent xContent,
 XContentParserConfiguration parserConfig,
 BytesReference data,
 CheckedBiConsumer<SearchRequest,XContentParser,IOException> consumer,
 String[] indices,
 IndicesOptions indicesOptions,
 String routing,
 String searchType,
 Boolean ccsMinimizeRoundtrips,
 boolean allowExplicitIndex,
 Optional<Boolean> crossProjectEnabled,
 @Nullable
 String projectRouting)
                                throws IOException

Throws:

IOException

readMultiLineFormat

public static void readMultiLineFormat(XContent xContent,
 XContentParserConfiguration parserConfig,
 BytesReference data,
 CheckedBiConsumer<SearchRequest,XContentParser,IOException> consumer,
 String[] indices,
 IndicesOptions indicesOptions,
 String routing,
 String searchType,
 Boolean ccsMinimizeRoundtrips,
 boolean allowExplicitIndex,
 TriFunction<String,Object,SearchRequest,Boolean> extraParamParser,
 Optional<Boolean> crossProjectEnabled,
 @Nullable
 String projectRouting)
                                throws IOException

Throws:

IOException

writeMultiLineFormat

public static byte[] writeMultiLineFormat(MultiSearchRequest multiSearchRequest,
 XContent xContent)
                                   throws IOException

Throws:

IOException

writeSearchRequestParams

public static void writeSearchRequestParams(SearchRequest request,
 XContentBuilder xContentBuilder)
                                     throws IOException

Throws:

IOException

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Description copied from interface: TaskAwareRequest

Returns the task object that should be used to keep track of the processing of the request.

Specified by:

createTask in interface TaskAwareRequest

allowsCrossProject

public boolean allowsCrossProject()

Description copied from interface: IndicesRequest.CrossProjectCandidate

Determines whether the request type can support cross-project processing. Cross-project processing entails 1. UIAM authentication and authorization projects resolution. 2. If applicable, cross-project flat-world index resolution and error handling Note: this method only determines in the request _supports_ cross-project. Whether cross-project processing is actually performed depends on other factors such as: - Whether CPS is enabled which impacts both 1 and 2. - Whether IndicesOptions supports it when the request is an IndicesRequest. This only impacts 2. See also CrossProjectModeDecider.

Specified by:

allowsCrossProject in interface IndicesRequest.CrossProjectCandidate

setProjectRouting

public void setProjectRouting(String projectRouting)

getProjectRouting

public String getProjectRouting()