Package org.elasticsearch.action

Class DocWriteResponse

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

All Implemented Interfaces:

WriteResponse, Writeable, StatusToXContentObject, RefCounted, ToXContent, ToXContentObject

Direct Known Subclasses:

DeleteResponse, IndexResponse, UpdateResponse

public abstract class DocWriteResponse
extends ReplicationResponse
implements WriteResponse, StatusToXContentObject

A base class for the response of a write operation that involves a single doc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocWriteResponse.Builder	Base class of all DocWriteResponse builders.
static enum	DocWriteResponse.Result	An enum that represents the results of CRUD operations, primarily used to communicate the type of operation that occurred.

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

Modifier and Type	Field	Description
protected final DocWriteResponse.Result	result

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

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocWriteResponse(StreamInput in)	Needed for deserialization of single item requests in IndexAction and BwC deserialization path
	DocWriteResponse(ShardId shardId, String type, String id, long seqNo, long primaryTerm, long version, DocWriteResponse.Result result)
protected	DocWriteResponse(ShardId shardId, StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	forcedRefresh()	Did this request force a refresh? Requests that set WriteRequest.setRefreshPolicy(RefreshPolicy) to WriteRequest.RefreshPolicy.IMMEDIATE will always return true for this.
String	getId()	The id of the document changed.
String	getIndex()	The index the document was changed in.
String	getLocation(String routing)	Return the relative URI for the location of the document suitable for use in the Location header.
long	getPrimaryTerm()	The primary term for this change.
DocWriteResponse.Result	getResult()	The change that occurred to the document.
long	getSeqNo()	Returns the sequence number assigned for this change.
ShardId	getShardId()	The exact shard the document was changed in.
String	getType()	Deprecated. Types are in the process of being removed.
long	getVersion()	Returns the current version of the doc.
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
protected static void	parseInnerToXContent(XContentParser parser, DocWriteResponse.Builder context)	Parse the output of the innerToXContent(XContentBuilder, Params) method.
void	setForcedRefresh(boolean forcedRefresh)	Mark the response as having forced a refresh? Requests that set WriteRequest.setRefreshPolicy(RefreshPolicy) to WriteRequest.RefreshPolicy.IMMEDIATE should always mark this as true.
RestStatus	status()	returns the rest status for this response (based on ReplicationResponse.ShardInfo.status()
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeThin(StreamOutput out)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

getShardInfo, setShardInfo

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

result

protected final DocWriteResponse.Result result

Constructor Details

DocWriteResponse

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

DocWriteResponse

protected DocWriteResponse(ShardId shardId,
 StreamInput in)
                    throws IOException

Throws:

IOException

DocWriteResponse

protected DocWriteResponse(StreamInput in)
                    throws IOException

Needed for deserialization of single item requests in IndexAction and BwC deserialization path

Throws:

IOException

Method Details

getResult

public DocWriteResponse.Result getResult()

The change that occurred to the document.

getIndex

public String getIndex()

The index the document was changed in.

getShardId

public ShardId getShardId()

The exact shard the document was changed in.

getType

@Deprecated
public String getType()

Deprecated.

Types are in the process of being removed.

The type of the document changed.

getId

public String getId()

The id of the document changed.

getVersion

public long getVersion()

Returns the current version of the doc.

getSeqNo

public long getSeqNo()

Returns the sequence number assigned for this change. Returns SequenceNumbers.UNASSIGNED_SEQ_NO if the operation wasn't performed (i.e., an update operation that resulted in a NOOP).

getPrimaryTerm

public long getPrimaryTerm()

The primary term for this change.

Returns:

the primary term

forcedRefresh

public boolean forcedRefresh()

Did this request force a refresh? Requests that set WriteRequest.setRefreshPolicy(RefreshPolicy) to WriteRequest.RefreshPolicy.IMMEDIATE will always return true for this. Requests that set it to WriteRequest.RefreshPolicy.WAIT_UNTIL will only return true here if they run out of refresh listener slots (see IndexSettings.MAX_REFRESH_LISTENERS_PER_SHARD).

setForcedRefresh

public void setForcedRefresh(boolean forcedRefresh)

Description copied from interface: WriteResponse

Mark the response as having forced a refresh? Requests that set WriteRequest.setRefreshPolicy(RefreshPolicy) to WriteRequest.RefreshPolicy.IMMEDIATE should always mark this as true. Requests that set it to WriteRequest.RefreshPolicy.WAIT_UNTIL will only set this to true if they run out of refresh listener slots (see IndexSettings.MAX_REFRESH_LISTENERS_PER_SHARD).

Specified by:

setForcedRefresh in interface WriteResponse

status

public RestStatus status()

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

Specified by:

status in interface StatusToXContentObject

getLocation

public String getLocation(@Nullable
 String routing)

Return the relative URI for the location of the document suitable for use in the Location header. The use of relative URIs is permitted as of HTTP/1.1 (cf. https://tools.ietf.org/html/rfc7231#section-7.1.2).

Parameters:

routing - custom routing or null if custom routing is not used

Returns:

the relative URI for the location of the document

writeThin

public void writeThin(StreamOutput out)
               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

Overrides:

writeTo in class ReplicationResponse

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

innerToXContent

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

Throws:

IOException

parseInnerToXContent

protected static void parseInnerToXContent(XContentParser parser,
 DocWriteResponse.Builder context)
                                    throws IOException

Parse the output of the innerToXContent(XContentBuilder, Params) method. This method is intended to be called by subclasses and must be called multiple times to parse all the information concerning DocWriteResponse objects. It always parses the current token, updates the given parsing context accordingly if needed and then immediately returns.

Throws:

IOException