Package org.elasticsearch.script.mustache

Class SearchTemplateRequest

  • All Implemented Interfaces:
    org.elasticsearch.action.CompositeIndicesRequest, org.elasticsearch.common.io.stream.Streamable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
    public class SearchTemplateRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.action.CompositeIndicesRequest, org.elasticsearch.common.xcontent.ToXContentObject
    A request to execute a search based on a search template.

    • Nested Class Summary

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

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

      • Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

        org.elasticsearch.transport.TransportRequest.Empty

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

        org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

    • Field Summary

      • Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

        EMPTY_PARAMS

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      static SearchTemplateRequest fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
      org.elasticsearch.action.search.SearchRequest getRequest()  
      java.lang.String getScript()  
      java.util.Map<java.lang.String,java.lang.Object> getScriptParams()  
      org.elasticsearch.script.ScriptType getScriptType()  
      int hashCode()  
      boolean isExplain()  
      boolean isProfile()  
      boolean isSimulate()  
      void readFrom​(org.elasticsearch.common.io.stream.StreamInput in)  
      void setExplain​(boolean explain)  
      void setProfile​(boolean profile)  
      void setRequest​(org.elasticsearch.action.search.SearchRequest request)  
      void setScript​(java.lang.String script)  
      void setScriptParams​(java.util.Map<java.lang.String,java.lang.Object> scriptParams)  
      void setScriptType​(org.elasticsearch.script.ScriptType scriptType)  
      void setSimulate​(boolean simulate)  
      org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
      org.elasticsearch.action.ActionRequestValidationException validate()  
      void writeTo​(org.elasticsearch.common.io.stream.StreamOutput out)  

      • Methods inherited from class org.elasticsearch.action.ActionRequest

        getShouldStoreResult

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

      • Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

        createTask, getDescription, setParentTask

      • Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

        isFragment

      • Methods inherited from class org.elasticsearch.transport.TransportMessage

        remoteAddress, remoteAddress

      • Methods inherited from class org.elasticsearch.transport.TransportRequest

        getParentTask, setParentTask

    • Constructor Detail

      • SearchTemplateRequest

        public SearchTemplateRequest()

      • SearchTemplateRequest

        public SearchTemplateRequest​(org.elasticsearch.action.search.SearchRequest searchRequest)

    • Method Detail

      • setRequest

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

      • getRequest

        public org.elasticsearch.action.search.SearchRequest getRequest()

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.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 org.elasticsearch.script.ScriptType getScriptType()

      • setScriptType

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

      • fromXContent

        public static SearchTemplateRequest fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • toXContent

        public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder,
                                                                    org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws java.io.IOException
        Specified by:
        toXContent in interface org.elasticsearch.common.xcontent.ToXContent
        Throws:
        java.io.IOException

      • readFrom

        public void readFrom​(org.elasticsearch.common.io.stream.StreamInput in)
              throws java.io.IOException
        Specified by:
        readFrom in interface org.elasticsearch.common.io.stream.Streamable
        Overrides:
        readFrom in class org.elasticsearch.action.ActionRequest
        Throws:
        java.io.IOException

      • writeTo

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