Class SearchTemplateRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.script.mustache.SearchTemplateRequest
-
- All Implemented Interfaces:
CompositeIndicesRequest
,Streamable
,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.elasticsearch.transport.TransportRequest
TransportRequest.Empty
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Field Summary
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description SearchTemplateRequest()
SearchTemplateRequest(SearchRequest searchRequest)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static SearchTemplateRequest
fromXContent(XContentParser parser)
SearchRequest
getRequest()
java.lang.String
getScript()
java.util.Map<java.lang.String,java.lang.Object>
getScriptParams()
ScriptType
getScriptType()
int
hashCode()
boolean
isExplain()
boolean
isProfile()
boolean
isSimulate()
void
readFrom(StreamInput in)
void
setExplain(boolean explain)
void
setProfile(boolean profile)
void
setRequest(SearchRequest request)
void
setScript(java.lang.String script)
void
setScriptParams(java.util.Map<java.lang.String,java.lang.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.elasticsearch.action.ActionRequest
getShouldStoreResult
-
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
-
Methods inherited from class org.elasticsearch.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.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Constructor Detail
-
SearchTemplateRequest
public SearchTemplateRequest()
-
SearchTemplateRequest
public SearchTemplateRequest(SearchRequest searchRequest)
-
-
Method Detail
-
setRequest
public void setRequest(SearchRequest request)
-
getRequest
public SearchRequest getRequest()
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.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 java.lang.String getScript()
-
setScript
public void setScript(java.lang.String script)
-
getScriptParams
public java.util.Map<java.lang.String,java.lang.Object> getScriptParams()
-
setScriptParams
public void setScriptParams(java.util.Map<java.lang.String,java.lang.Object> scriptParams)
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
fromXContent
public static SearchTemplateRequest fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
readFrom
public void readFrom(StreamInput in) throws java.io.IOException
- Specified by:
readFrom
in interfaceStreamable
- Overrides:
readFrom
in classActionRequest
- Throws:
java.io.IOException
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
- Specified by:
writeTo
in interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
java.io.IOException
-
-