Module org.elasticsearch.server

Package org.elasticsearch.index.get

Class GetResult

java.lang.Object

org.elasticsearch.index.get.GetResult

All Implemented Interfaces:

Iterable<DocumentField>, Writeable, ToXContent, ToXContentObject

public class GetResult
extends Object
implements Writeable, Iterable<DocumentField>, ToXContentObject

Nested Class Summary

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

Modifier and Type	Field	Description
static final String	_ID
static final String	_INDEX

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GetResult(String index, String id, long seqNo, long primaryTerm, long version, boolean exists, BytesReference source, Map<String,DocumentField> documentFields, Map<String,DocumentField> metaFields)
GetResult(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DocumentField	field(String name)
static GetResult	fromXContent(XContentParser parser)
static GetResult	fromXContentEmbedded(XContentParser parser)
static GetResult	fromXContentEmbedded(XContentParser parser, String index, String id)
Map<String,DocumentField>	getDocumentFields()
Map<String,DocumentField>	getFields()
String	getId()	The id of the document.
String	getIndex()	The index the document was fetched from.
Map<String,DocumentField>	getMetadataFields()
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()
long	getVersion()	The version of the doc.
int	hashCode()
BytesReference	internalSourceRef()	Internal source representation, might be compressed....
boolean	isExists()	Does the document exist.
boolean	isSourceEmpty()	Is the source empty (not available) or not.
Iterator<DocumentField>	iterator()
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.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentEmbedded(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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.xcontent.ToXContentObject

isFragment

Field Details

_INDEX

public static final String _INDEX

See Also:

• Constant Field Values

_ID

public static final String _ID

See Also:

• Constant Field Values

Constructor Details

GetResult

public GetResult(StreamInput in)
          throws IOException

Throws:

IOException

GetResult

public GetResult(String index,
 String id,
 long seqNo,
 long primaryTerm,
 long version,
 boolean exists,
 BytesReference source,
 Map<String,DocumentField> documentFields,
 Map<String,DocumentField> metaFields)

Method Details

isExists

public boolean isExists()

Does the document exist.

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.

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

getMetadataFields

public Map<String,DocumentField> getMetadataFields()

getDocumentFields

public Map<String,DocumentField> getDocumentFields()

getFields

public Map<String,DocumentField> getFields()

field

public DocumentField field(String name)

iterator

public Iterator<DocumentField> iterator()

Specified by:

iterator in interface Iterable<DocumentField>

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

fromXContentEmbedded

public static GetResult fromXContentEmbedded(XContentParser parser)
                                      throws IOException

Throws:

IOException

fromXContentEmbedded

public static GetResult fromXContentEmbedded(XContentParser parser,
 String index,
 String id)
                                      throws IOException

Throws:

IOException

fromXContent

public static GetResult fromXContent(XContentParser parser)
                              throws IOException

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