Class MultiSearchTemplateRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.script.mustache.MultiSearchTemplateRequest
All Implemented Interfaces:
org.elasticsearch.action.CompositeIndicesRequest, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.util.concurrent.RefCounted, org.elasticsearch.tasks.TaskAwareRequest

public class MultiSearchTemplateRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.action.CompositeIndicesRequest
  • 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.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>
  • Constructor Summary

    Constructors
    Constructor Description
    MultiSearchTemplateRequest()  
    MultiSearchTemplateRequest​(org.elasticsearch.common.io.stream.StreamInput in)  
  • Method Summary

    Modifier and Type Method Description
    MultiSearchTemplateRequest add​(SearchTemplateRequest request)
    Add a search template request to execute.
    MultiSearchTemplateRequest add​(SearchTemplateRequestBuilder request)
    Add a search template request to execute.
    boolean equals​(java.lang.Object o)  
    int hashCode()  
    org.elasticsearch.action.support.IndicesOptions indicesOptions()  
    MultiSearchTemplateRequest indicesOptions​(org.elasticsearch.action.support.IndicesOptions indicesOptions)  
    int maxConcurrentSearchRequests()
    Returns the amount of search requests specified in this multi search requests are allowed to be ran concurrently.
    MultiSearchTemplateRequest maxConcurrentSearchRequests​(int maxConcurrentSearchRequests)
    Sets how many search requests specified in this multi search requests are allowed to be ran concurrently.
    java.util.List<SearchTemplateRequest> requests()  
    org.elasticsearch.action.ActionRequestValidationException validate()  
    static byte[] writeMultiLineFormat​(MultiSearchTemplateRequest multiSearchTemplateRequest, org.elasticsearch.common.xcontent.XContent xContent)  
    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, 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
  • Constructor Details

    • MultiSearchTemplateRequest

      public MultiSearchTemplateRequest()
    • MultiSearchTemplateRequest

      public MultiSearchTemplateRequest​(org.elasticsearch.common.io.stream.StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • add

      Add a search template request to execute. Note, the order is important, the search response will be returned in the same order as the search requests.
    • add

      Add a search template request to execute. Note, the order is important, the search response will be returned in the same order as the search requests.
    • maxConcurrentSearchRequests

      public int maxConcurrentSearchRequests()
      Returns the amount of search requests specified in this multi search requests are allowed to be ran concurrently.
    • maxConcurrentSearchRequests

      public MultiSearchTemplateRequest maxConcurrentSearchRequests​(int maxConcurrentSearchRequests)
      Sets how many search requests specified in this multi search requests are allowed to be ran concurrently.
    • requests

      public java.util.List<SearchTemplateRequest> requests()
    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest
    • indicesOptions

      public org.elasticsearch.action.support.IndicesOptions indicesOptions()
    • indicesOptions

      public MultiSearchTemplateRequest indicesOptions​(org.elasticsearch.action.support.IndicesOptions indicesOptions)
    • 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.Writeable
      Overrides:
      writeTo in class org.elasticsearch.action.ActionRequest
      Throws:
      java.io.IOException
    • 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
    • writeMultiLineFormat

      public static byte[] writeMultiLineFormat​(MultiSearchTemplateRequest multiSearchTemplateRequest, org.elasticsearch.common.xcontent.XContent xContent) throws java.io.IOException
      Throws:
      java.io.IOException