Package org.opensearch.script.mustache

Class MultiSearchTemplateRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.script.mustache.MultiSearchTemplateRequest

All Implemented Interfaces:

CompositeIndicesRequest, org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

public class MultiSearchTemplateRequest
extends ActionRequest
implements CompositeIndicesRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.transport.TransportRequest

TransportRequest.Empty

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

org.opensearch.core.common.io.stream.Writeable.Reader<V extends Object>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V extends Object>

Constructor Summary

Constructors

Constructor	Description
MultiSearchTemplateRequest()
MultiSearchTemplateRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
MultiSearchTemplateRequest	add(SearchTemplateRequest request)	Add a search template request to execute.
MultiSearchTemplateRequest	add(SearchTemplateRequestBuilder request)	Add a search template request to execute.
boolean	equals(Object o)
int	hashCode()
IndicesOptions	indicesOptions()
MultiSearchTemplateRequest	indicesOptions(IndicesOptions indicesOptions)
int	maxConcurrentSearchRequests()	Returns the amount of search requests specified in this multi search requests are allowed to be ran concurrently.
MultiSearchTemplateRequest	maxConcurrentSearchRequests(int maxConcurrentSearchRequests)	Sets how many search requests specified in this multi search requests are allowed to be ran concurrently.
List<SearchTemplateRequest>	requests()
ActionRequestValidationException	validate()
static byte[]	writeMultiLineFormat(MultiSearchTemplateRequest multiSearchTemplateRequest, org.opensearch.core.xcontent.XContent xContent)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

MultiSearchTemplateRequest

public MultiSearchTemplateRequest()

MultiSearchTemplateRequest

public MultiSearchTemplateRequest(org.opensearch.core.common.io.stream.StreamInput in)
                           throws IOException

Throws:

IOException

Method Details

add

public MultiSearchTemplateRequest add(SearchTemplateRequestBuilder request)

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

add

public MultiSearchTemplateRequest add(SearchTemplateRequest request)

Add a search template 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 MultiSearchTemplateRequest maxConcurrentSearchRequests(int maxConcurrentSearchRequests)

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

requests

public List<SearchTemplateRequest> requests()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

indicesOptions

public IndicesOptions indicesOptions()

indicesOptions

public MultiSearchTemplateRequest indicesOptions(IndicesOptions indicesOptions)

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.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

writeMultiLineFormat

public static byte[] writeMultiLineFormat(MultiSearchTemplateRequest multiSearchTemplateRequest,
 org.opensearch.core.xcontent.XContent xContent)
                                   throws IOException

Throws:

IOException