Package org.opensearch.action.search

Class MultiSearchResponse.Item

java.lang.Object
org.opensearch.action.search.MultiSearchResponse.Item
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable
Enclosing class:
MultiSearchResponse
@PublicApi(since="1.0.0") public static class MultiSearchResponse.Item extends Object implements org.opensearch.core.common.io.stream.Writeable
A search response item, holding the actual search response, or an error message if it failed.
Opensearch.api:

  • Nested Class Summary

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • Constructor Summary

    Constructors
    Constructor
    Description
    Item(SearchResponse response, Exception exception)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Exception
    getFailure()
     
    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(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • 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
      Throws:
      IOException

    • isFailure

      public boolean isFailure()
      Is it a failed search?

    • getFailureMessage

      @Nullable public 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 Exception getFailure()