Package org.elasticsearch.action.get
Class GetResponse
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportResponse
org.elasticsearch.action.ActionResponse
org.elasticsearch.action.get.GetResponse
- All Implemented Interfaces:
<DocumentField>
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,org.elasticsearch.core.RefCounted
public class GetResponse
extends ActionResponse
implements <DocumentField>, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
o)
static GetResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
This method can be used to parse aGetResponse
object when it has been printed out as a xcontent using thetoXContent(XContentBuilder, Params)
method.name)
<,DocumentField>
getId()
The id of the document.getIndex()
The index the document was fetched from.long
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.<,>
byte[]
The source of the document if exists.Returns bytes reference, also un compress the source if needed.<,>
The source of the document (As a map).The source of the document (as a string).Returns the internal source bytes, as they are returned without munging (for example, might still be compressed).getType()
The type of the document.long
The version of the doc.int
hashCode()
boolean
isExists()
Does the document exists.boolean
Is the source empty (not available) or not.iterator()
Deprecated.toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportMessage
decRef, incRef, remoteAddress, remoteAddress, tryIncRef
Methods inherited from class java.lang.
, , , , , , ,
Methods inherited from interface java.lang.
,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
GetResponse
-
-
Method Details
-
isExists
public boolean isExists()Does the document exists. -
getIndex
public getIndex()The index the document was fetched from. -
getType
public getType()The type of the document. -
getId
public 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. -
getSourceAsBytes
public byte[] getSourceAsBytes()The source of the document if exists. -
getSourceInternal
Returns the internal source bytes, as they are returned without munging (for example, might still be compressed). -
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 getSourceAsString()The source of the document (as a string). -
getSourceAsMap
The source of the document (As a map).- Throws:
ElasticsearchParseException
-
getSource
public <,> getSource() -
getFields
-
getField
public name) -
iterator
Deprecated.UsegetSource()
instead- Specified by:
in interface
<DocumentField>
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
-
fromXContent
public static GetResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throwsThis method can be used to parse aGetResponse
object when it has been printed out as a xcontent using thetoXContent(XContentBuilder, Params)
method.For forward compatibility reason this method might not fail if it tries to parse a field it doesn't know. But before returning the result it will check that enough information were parsed to return a valid
GetResponse
instance and throws aParsingException
otherwise. This is the case when we get a 404 back, which can be parsed as a normalGetResponse
with found set to false, or as an elasticsearch exception. The caller of this method needs a way to figure out whether we got back a valid get response, which can be done by catching ParsingException.- Parameters:
parser
-XContentParser
to parse the response from- Returns:
- a
GetResponse
- Throws:
- is an I/O exception occurs during the parsing
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
equals
public boolean equals( o)- Overrides:
in class
-
hashCode
public int hashCode()- Overrides:
in class
-
toString
public toString()- Overrides:
in class
-
getSource()
instead