org.elasticsearch.action.search
Class MultiSearchResponse.Item

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

public static class MultiSearchResponse.Item
extends Object
implements Streamable

A search response item, holding the actual search response, or an error message if it failed.


Constructor Summary
MultiSearchResponse.Item(SearchResponse response, String failureMessage)
           
 
Method Summary
 String failureMessage()
          The actual failure message, null if its not a failure.
 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 readFrom(StreamInput in)
           
static MultiSearchResponse.Item readItem(StreamInput in)
           
 SearchResponse response()
          The actual search response, null if its a failure.
 void writeTo(StreamOutput out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiSearchResponse.Item

public MultiSearchResponse.Item(SearchResponse response,
                                String failureMessage)
Method Detail

isFailure

public boolean isFailure()
Is it a failed search?


failureMessage

@Nullable
public String failureMessage()
The actual failure message, null if its not a failure.


getFailureMessage

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


response

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


getResponse

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


readItem

public static MultiSearchResponse.Item readItem(StreamInput in)
                                         throws IOException
Throws:
IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException
Specified by:
readFrom in interface Streamable
Throws:
IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException
Specified by:
writeTo in interface Streamable
Throws:
IOException


Copyright © 2009-2012. All Rights Reserved.