Package org.opensearch.script.mustache

Class SearchTemplateRequest

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.script.mustache.SearchTemplateRequest
All Implemented Interfaces:
CompositeIndicesRequest, IndicesRequest, IndicesRequest.Replaceable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, TaskAwareRequest
public class SearchTemplateRequest extends ActionRequest implements IndicesRequest.Replaceable, CompositeIndicesRequest, org.opensearch.core.xcontent.ToXContentObject
A request to execute a search based on a search template.

  • Constructor Details

    • SearchTemplateRequest

      public SearchTemplateRequest()

    • SearchTemplateRequest

      public SearchTemplateRequest(org.opensearch.core.common.io.stream.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(org.opensearch.core.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException

    • toXContent

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

    • 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

    • indices

      public String[] indices()
      Specified by:
      indices in interface IndicesRequest

    • indicesOptions

      public IndicesOptions indicesOptions()
      Specified by:
      indicesOptions in interface IndicesRequest

    • indices

      public IndicesRequest indices(String... indices)
      Specified by:
      indices in interface IndicesRequest.Replaceable