Package org.opensearch.script.mustache

Class SearchTemplateRequest

java.lang.Object

org.opensearch.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.script.mustache.SearchTemplateRequest

All Implemented Interfaces:

CompositeIndicesRequest, Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class SearchTemplateRequest
extends ActionRequest
implements CompositeIndicesRequest, ToXContentObject

A request to execute a search based on a search template.

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchTemplateRequest()
SearchTemplateRequest(SearchRequest searchRequest)
SearchTemplateRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SearchTemplateRequest	fromXContent(XContentParser parser)
SearchRequest	getRequest()
String	getScript()
Map<String,Object>	getScriptParams()
ScriptType	getScriptType()
int	hashCode()
boolean	isExplain()
boolean	isProfile()
boolean	isSimulate()
void	setExplain(boolean explain)
void	setProfile(boolean profile)
void	setRequest(SearchRequest request)
void	setScript(String script)
void	setScriptParams(Map<String,Object> scriptParams)
void	setScriptType(ScriptType scriptType)
void	setSimulate(boolean simulate)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(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.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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Constructor Details

SearchTemplateRequest

public SearchTemplateRequest()

SearchTemplateRequest

public SearchTemplateRequest(StreamInput in)
                      throws IOException

Throws:

IOException

SearchTemplateRequest

public SearchTemplateRequest(SearchRequest searchRequest)

Method Details

setRequest

public void setRequest(SearchRequest request)

getRequest

public SearchRequest getRequest()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isSimulate

public boolean isSimulate()

setSimulate

public void setSimulate(boolean simulate)

isExplain

public boolean isExplain()

setExplain

public void setExplain(boolean explain)

isProfile

public boolean isProfile()

setProfile

public void setProfile(boolean profile)

getScriptType

public ScriptType getScriptType()

setScriptType

public void setScriptType(ScriptType scriptType)

getScript

public String getScript()

setScript

public void setScript(String script)

getScriptParams

public Map<String,Object> getScriptParams()

setScriptParams

public void setScriptParams(Map<String,Object> scriptParams)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

fromXContent

public static SearchTemplateRequest fromXContent(XContentParser parser)
                                          throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException