Module org.elasticsearch.server

Package org.elasticsearch.action.get

Class MultiGetItemResponse

java.lang.Object

org.elasticsearch.action.get.MultiGetItemResponse

All Implemented Interfaces:

Writeable

public class MultiGetItemResponse
extends Object
implements Writeable

A single multi get response.

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
MultiGetItemResponse(GetResponse response, MultiGetResponse.Failure failure)

Method Summary

Modifier and Type	Method	Description
MultiGetResponse.Failure	getFailure()	The failure if relevant.
String	getId()	The id of the document.
String	getIndex()	The index name of the document.
GetResponse	getResponse()	The actual get response, null if its a failure.
boolean	isFailed()	Is this a failed execution?
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

MultiGetItemResponse

public MultiGetItemResponse(GetResponse response,
 MultiGetResponse.Failure failure)

Method Details

getIndex

public String getIndex()

The index name of the document.

getId

public String getId()

The id of the document.

isFailed

public boolean isFailed()

Is this a failed execution?

getResponse

public GetResponse getResponse()

The actual get response, null if its a failure.

getFailure

public MultiGetResponse.Failure getFailure()

The failure if relevant.

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