Module org.elasticsearch.server

Package org.elasticsearch.action.update

Class UpdateResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.replication.ReplicationResponse

org.elasticsearch.action.DocWriteResponse

org.elasticsearch.action.update.UpdateResponse

All Implemented Interfaces:

WriteResponse, Writeable, RefCounted, ToXContent, ToXContentObject

public class UpdateResponse
extends DocWriteResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateResponse.Builder	Builder class for UpdateResponse.

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

DocWriteResponse.Result

Nested classes/interfaces inherited from class org.elasticsearch.action.support.replication.ReplicationResponse

ReplicationResponse.ShardInfo

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 class org.elasticsearch.action.DocWriteResponse

_ID, _INDEX, _PRIMARY_TERM, _SEQ_NO, _SHARDS, _VERSION, FORCED_REFRESH, result, RESULT

Fields inherited from class org.elasticsearch.action.support.replication.ReplicationResponse

NO_FAILURES

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
UpdateResponse(ReplicationResponse.ShardInfo shardInfo, ShardId shardId, String id, long seqNo, long primaryTerm, long version, DocWriteResponse.Result result)
UpdateResponse(StreamInput in)
UpdateResponse(ShardId shardId, String id, long seqNo, long primaryTerm, long version, DocWriteResponse.Result result)	Constructor to be used when a update didn't translate in a write.
UpdateResponse(ShardId shardId, StreamInput in)

Method Summary

Modifier and Type	Method	Description
GetResult	getGetResult()
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
void	setGetResult(GetResult getResult)
RestStatus	status()	returns the rest status for this response (based on ReplicationResponse.ShardInfo.status()
String	toString()
UpdateResponse	withoutSequenceNumber()	Returns an equivalent response with the sequence number and primary term set to SequenceNumbers.UNASSIGNED_SEQ_NO and SequenceNumbers.UNASSIGNED_PRIMARY_TERM.
void	writeThin(StreamOutput out)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.DocWriteResponse

copyMutableFieldsTo, forcedRefresh, getFailureStoreStatus, getId, getIndex, getLocation, getPrimaryTerm, getResult, getSeqNo, getShardId, getVersion, setForcedRefresh, toXContent

Methods inherited from class org.elasticsearch.action.support.replication.ReplicationResponse

getShardInfo, setShardInfo

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

UpdateResponse

public UpdateResponse(ShardId shardId,
 StreamInput in)
               throws IOException

Throws:

IOException

UpdateResponse

public UpdateResponse(StreamInput in)
               throws IOException

Throws:

IOException

UpdateResponse

public UpdateResponse(ShardId shardId,
 String id,
 long seqNo,
 long primaryTerm,
 long version,
 DocWriteResponse.Result result)

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(ReplicationResponse.ShardInfo shardInfo,
 ShardId shardId,
 String id,
 long seqNo,
 long primaryTerm,
 long version,
 DocWriteResponse.Result result)

Method Details

setGetResult

public void setGetResult(GetResult getResult)

getGetResult

public GetResult getGetResult()

withoutSequenceNumber

public UpdateResponse withoutSequenceNumber()

Description copied from class: DocWriteResponse

Returns an equivalent response with the sequence number and primary term set to SequenceNumbers.UNASSIGNED_SEQ_NO and SequenceNumbers.UNASSIGNED_PRIMARY_TERM. Used to strip internal sequence numbers from user-facing responses when index.disable_sequence_numbers is enabled.

Specified by:

withoutSequenceNumber in class DocWriteResponse

status

public RestStatus status()

Description copied from class: DocWriteResponse

returns the rest status for this response (based on ReplicationResponse.ShardInfo.status()

Overrides:

status in class DocWriteResponse

writeThin

public void writeThin(StreamOutput out)
               throws IOException

Overrides:

writeThin in class DocWriteResponse

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

Overrides:

writeTo in class DocWriteResponse

Throws:

IOException

innerToXContent

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

Overrides:

innerToXContent in class DocWriteResponse

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object