Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class MultiSearchResponse.Item

java.lang.Object

org.elasticsearch.action.search.MultiSearchResponse.Item

All Implemented Interfaces:

Writeable, ChunkedToXContent

Enclosing class:

MultiSearchResponse

public static class MultiSearchResponse.Item
extends Object
implements Writeable, ChunkedToXContent

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>

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

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?
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

Constructor Details

Item

public Item(@Nullable
 SearchResponse response,
 @Nullable
 Exception exception)

Parameters:

response - search response that is considered owned by this instance after this constructor returns or null

exception - exception in case of search failure

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

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()