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:
org.elasticsearch.action.CompositeIndicesRequest, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class SearchTemplateRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.action.CompositeIndicesRequest, org.elasticsearch.xcontent.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

    org.elasticsearch.transport.TransportRequest.Empty

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>
  • Field Summary

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    SearchTemplateRequest(org.elasticsearch.action.search.SearchRequest searchRequest)
     
    SearchTemplateRequest(org.elasticsearch.common.io.stream.StreamInput in)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    fromXContent(org.elasticsearch.xcontent.XContentParser parser)
     
    org.elasticsearch.action.search.SearchRequest
     
     
     
    org.elasticsearch.script.ScriptType
     
    int
     
    boolean
     
    boolean
     
    boolean
     
    void
    setExplain(boolean explain)
     
    void
    setProfile(boolean profile)
     
    void
    setRequest(org.elasticsearch.action.search.SearchRequest request)
     
    void
    setScript(String script)
     
    void
     
    void
    setScriptType(org.elasticsearch.script.ScriptType scriptType)
     
    void
    setSimulate(boolean simulate)
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    org.elasticsearch.action.ActionRequestValidationException
     
    void
    writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask, toString

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment
  • Constructor Details

    • SearchTemplateRequest

      public SearchTemplateRequest()
    • SearchTemplateRequest

      public SearchTemplateRequest(org.elasticsearch.common.io.stream.StreamInput in) throws IOException
      Throws:
      IOException
    • SearchTemplateRequest

      public SearchTemplateRequest(org.elasticsearch.action.search.SearchRequest searchRequest)
  • Method Details

    • setRequest

      public void setRequest(org.elasticsearch.action.search.SearchRequest request)
    • getRequest

      public org.elasticsearch.action.search.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 org.elasticsearch.script.ScriptType getScriptType()
    • setScriptType

      public void setScriptType(org.elasticsearch.script.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 org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest
    • fromXContent

      public static SearchTemplateRequest fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • writeTo

      public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.elasticsearch.common.io.stream.Writeable
      Overrides:
      writeTo in class org.elasticsearch.action.ActionRequest
      Throws:
      IOException