org.elasticsearch.index.get

Class GetResult

java.lang.Object

org.elasticsearch.index.get.GetResult

All Implemented Interfaces:

Iterable<GetField>, Streamable, ToXContent

public class GetResult
extends Object
implements Streamable, Iterable<GetField>, ToXContent

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
GetResult(String index, String type, String id, long version, boolean exists, BytesReference source, Map<String,GetField> fields)

Method Summary

Methods

Modifier and Type	Method and Description
GetField	field(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()
String	getType() The type of the document.
long	getVersion() The version of the doc.
BytesReference	internalSourceRef() Internal source representation, might be compressed....
boolean	isExists() Does the document exists.
boolean	isSourceEmpty() Is the source empty (not available) or not.
Iterator<GetField>	iterator()
void	readFrom(StreamInput in)
static GetResult	readGetResult(StreamInput in)
byte[]	source() The source of the document if exists.
Map<String,Object>	sourceAsMap() The source of the document (As a map).
String	sourceAsString() The source of the document (as a string).
BytesReference	sourceRef() Returns bytes reference, also un compress the source if needed.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentEmbedded(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetResult

public GetResult(String index,
         String type,
         String id,
         long version,
         boolean exists,
         BytesReference source,
         Map<String,GetField> fields)

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.

source

public byte[] source()

The source of the document if exists.

sourceRef

public BytesReference sourceRef()

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

internalSourceRef

public BytesReference internalSourceRef()

Internal source representation, might be compressed....

isSourceEmpty

public boolean isSourceEmpty()

Is the source empty (not available) or not.

sourceAsString

public String sourceAsString()

The source of the document (as a string).

sourceAsMap

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

The source of the document (As a map).

Throws:

ElasticsearchParseException

getSource

public Map<String,Object> getSource()

getFields

public Map<String,GetField> getFields()

field

public GetField field(String name)

iterator

public Iterator<GetField> iterator()

Specified by:

iterator in interface Iterable<GetField>

toXContentEmbedded

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

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readGetResult

public static GetResult readGetResult(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