Module org.elasticsearch.server

Package org.elasticsearch.action.get

Class GetResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.get.GetResponse

All Implemented Interfaces:

Iterable<DocumentField>, Writeable, RefCounted, ToXContent, ToXContentObject

public class GetResponse
extends ActionResponse
implements Iterable<DocumentField>, ToXContentObject

The response of a get action.

See Also:

• GetRequest
• Client.get(GetRequest)

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetResponse(StreamInput in)
GetResponse(GetResult getResult)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DocumentField	getField(String name)
Map<String,DocumentField>	getFields()
String	getId()	The id of the document.
String	getIndex()	The index the document was fetched from.
long	getPrimaryTerm()	The primary term of the last primary that has changed this document, if found.
long	getSeqNo()	The sequence number assigned to the last operation that has changed this document, if found.
Map<String,Object>	getSource()
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).
long	getVersion()	The version of the doc.
int	hashCode()
boolean	isExists()	Does the document exists.
boolean	isSourceEmpty()	Is the source empty (not available) or not.
Iterator<DocumentField>	iterator()	Deprecated. Use getSource() instead
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

GetResponse

public GetResponse(StreamInput in)
            throws IOException

Throws:

IOException

GetResponse

public GetResponse(GetResult getResult)

Method Details

isExists

public boolean isExists()

Does the document exists.

getIndex

public String getIndex()

The index the document was fetched from.

getId

public String getId()

The id of the document.

getVersion

public long getVersion()

The version of the doc.

getSeqNo

public long getSeqNo()

The sequence number assigned to the last operation that has changed this document, if found.

getPrimaryTerm

public long getPrimaryTerm()

The primary term of the last primary that has changed this document, if found.

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,DocumentField> getFields()

getField

public DocumentField getField(String name)

iterator

@Deprecated
public Iterator<DocumentField> iterator()

Deprecated.

Use getSource() instead

Specified by:

iterator in interface Iterable<DocumentField>

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object