org.elasticsearch.action.update

Class UpdateResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.ActionWriteResponse

org.elasticsearch.action.update.UpdateResponse

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class UpdateResponse
extends ActionWriteResponse

Nested Class Summary

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

ActionWriteResponse.ShardInfo

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

TransportResponse.Empty

Field Summary

Fields inherited from class org.elasticsearch.action.ActionWriteResponse

EMPTY

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
UpdateResponse()
UpdateResponse(ActionWriteResponse.ShardInfo shardInfo, String index, String type, String id, long version, boolean created)
UpdateResponse(String index, String type, String id, long version, boolean created) Constructor to be used when a update didn't translate in a write.

Method Summary

Methods

Modifier and Type	Method and Description
GetResult	getGetResult()
String	getId() The id of the document indexed.
String	getIndex() The index the document was indexed into.
String	getType() The type of the document indexed.
long	getVersion() Returns the current version of the doc indexed.
boolean	isCreated() Returns true if document was created due to an UPSERT operation
void	readFrom(StreamInput in)
void	setGetResult(GetResult getResult)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionWriteResponse

getShardInfo, setShardInfo

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

UpdateResponse

public UpdateResponse()

UpdateResponse

public UpdateResponse(String index,
              String type,
              String id,
              long version,
              boolean created)

Constructor to be used when a update didn't translate in a write. For example: update script with operation set to none

UpdateResponse

public UpdateResponse(ActionWriteResponse.ShardInfo shardInfo,
              String index,
              String type,
              String id,
              long version,
              boolean created)

Method Detail

getIndex

public String getIndex()

The index the document was indexed into.

getType

public String getType()

The type of the document indexed.

getId

public String getId()

The id of the document indexed.

getVersion

public long getVersion()

Returns the current version of the doc indexed.

setGetResult

public void setGetResult(GetResult getResult)

getGetResult

public GetResult getGetResult()

isCreated

public boolean isCreated()

Returns true if document was created due to an UPSERT operation

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionWriteResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionWriteResponse

Throws:

IOException