org.elasticsearch.action.get

Class GetResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.get.GetResponse

All Implemented Interfaces:

Iterable<GetField>, HasContext, HasContextAndHeaders, HasHeaders, Streamable, ToXContent

public class GetResponse
extends ActionResponse
implements Iterable<GetField>, ToXContent

The response of a get action.

See Also:

GetRequest, Client.get(GetRequest)

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
GetResponse(GetResult getResult)

Method Summary

Methods

Modifier and Type	Method and Description
GetField	getField(String name)
Map<String,GetField>	getFields()
String	getId() The id of the document.
String	getIndex() The index the document was fetched from.
Map<String,Object>	getSource()
byte[]	getSourceAsBytes() The source of the document if exists.
BytesReference	getSourceAsBytesRef() Returns bytes reference, also un compress the source if needed.
Map<String,Object>	getSourceAsMap() The source of the document (As a map).
String	getSourceAsString() The source of the document (as a string).
BytesReference	getSourceInternal() Returns the internal source bytes, as they are returned without munging (for example, might still be compressed).
String	getType() The type of the document.
long	getVersion() The version of the doc.
boolean	isExists() Does the document exists.
boolean	isSourceEmpty() Is the source empty (not available) or not.
Iterator<GetField>	iterator()
void	readFrom(StreamInput in)
static GetResponse	readGetResponse(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

GetResponse

public GetResponse(GetResult getResult)

Method Detail

isExists

public boolean isExists()

Does the document exists.

getIndex

public String getIndex()

The index the document was fetched from.

getType

public String getType()

The type of the document.

getId

public String getId()

The id of the document.

getVersion

public long getVersion()

The version of the doc.

getSourceAsBytes

public byte[] getSourceAsBytes()

The source of the document if exists.

getSourceInternal

public BytesReference getSourceInternal()

Returns the internal source bytes, as they are returned without munging (for example, might still be compressed).

getSourceAsBytesRef

public BytesReference getSourceAsBytesRef()

Returns bytes reference, also un compress the source if needed.

isSourceEmpty

public boolean isSourceEmpty()

Is the source empty (not available) or not.

getSourceAsString

public String getSourceAsString()

The source of the document (as a string).

getSourceAsMap

public Map<String,Object> getSourceAsMap()
                                  throws ElasticsearchParseException

The source of the document (As a map).

Throws:

ElasticsearchParseException

getSource

public Map<String,Object> getSource()

getFields

public Map<String,GetField> getFields()

getField

public GetField getField(String name)

iterator

public Iterator<GetField> iterator()

Specified by:

iterator in interface Iterable<GetField>

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readGetResponse

public static GetResponse readGetResponse(StreamInput in)
                                   throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException