Class MultiSearchResponse.Item

java.lang.Object
org.elasticsearch.action.search.MultiSearchResponse.Item
All Implemented Interfaces:
Writeable
Enclosing class:
MultiSearchResponse

public static class MultiSearchResponse.Item
extends java.lang.Object
implements Writeable
A search response item, holding the actual search response, or an error message if it failed.
  • Nested Class Summary

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

    Writeable.Reader<V>, Writeable.Writer<V>
  • Constructor Summary

    Constructors
    Constructor Description
    Item​(SearchResponse response, java.lang.Exception exception)  
  • Method Summary

    Modifier and Type Method Description
    java.lang.Exception getFailure()  
    java.lang.String getFailureMessage()
    The actual failure message, null if its not a failure.
    SearchResponse getResponse()
    The actual search response, null if its a failure.
    boolean isFailure()
    Is it a failed search?
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Item

      public Item​(SearchResponse response, java.lang.Exception exception)
  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • isFailure

      public boolean isFailure()
      Is it a failed search?
    • getFailureMessage

      @Nullable public java.lang.String getFailureMessage()
      The actual failure message, null if its not a failure.
    • getResponse

      @Nullable public SearchResponse getResponse()
      The actual search response, null if its a failure.
    • getFailure

      public java.lang.Exception getFailure()