Module org.elasticsearch.server

Package org.elasticsearch.action.index

Class IndexResponse

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.index.IndexResponse

All Implemented Interfaces:

WriteResponse, Writeable, RefCounted, ToXContent, ToXContentObject

Direct Known Subclasses:

SimulateIndexResponse

public class IndexResponse
extends DocWriteResponse

A response of an index operation,

See Also:

• IndexRequest
• Client.index(IndexRequest)

Nested Class Summary

Nested Classes

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

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

Modifier and Type	Field	Description
protected final List<String>	executedPipelines

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
IndexResponse(StreamInput in)
IndexResponse(ShardId shardId, String id, long seqNo, long primaryTerm, long version, boolean created)
IndexResponse(ShardId shardId, String id, long seqNo, long primaryTerm, long version, boolean created, List<String> executedPipelines)
IndexResponse(ShardId shardId, String id, long seqNo, long primaryTerm, long version, boolean created, List<String> executedPipelines, IndexDocFailureStoreStatus failureStoreStatus)
IndexResponse(ShardId shardId, StreamInput in)

Method Summary

Modifier and Type	Method	Description
IndexDocFailureStoreStatus	getFailureStoreStatus()
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
void	setFailureStoreStatus(IndexDocFailureStoreStatus failureStoreStatus)
RestStatus	status()	returns the rest status for this response (based on ReplicationResponse.ShardInfo.status()
String	toString()
IndexResponse	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, 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

Field Details

executedPipelines

@Nullable
protected final List<String> executedPipelines

Constructor Details

IndexResponse

public IndexResponse(ShardId shardId,
 StreamInput in)
              throws IOException

Throws:

IOException

IndexResponse

public IndexResponse(StreamInput in)
              throws IOException

Throws:

IOException

IndexResponse

public IndexResponse(ShardId shardId,
 String id,
 long seqNo,
 long primaryTerm,
 long version,
 boolean created)

IndexResponse

public IndexResponse(ShardId shardId,
 String id,
 long seqNo,
 long primaryTerm,
 long version,
 boolean created,
 @Nullable
 List<String> executedPipelines)

IndexResponse

public IndexResponse(ShardId shardId,
 String id,
 long seqNo,
 long primaryTerm,
 long version,
 boolean created,
 @Nullable
 List<String> executedPipelines,
 IndexDocFailureStoreStatus failureStoreStatus)

Method Details

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

writeThin

public void writeThin(StreamOutput out)
               throws IOException

Overrides:

writeThin in class DocWriteResponse

Throws:

IOException

innerToXContent

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

Overrides:

innerToXContent in class DocWriteResponse

Throws:

IOException

withoutSequenceNumber

public IndexResponse 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

setFailureStoreStatus

public void setFailureStoreStatus(IndexDocFailureStoreStatus failureStoreStatus)

getFailureStoreStatus

public IndexDocFailureStoreStatus getFailureStoreStatus()

Overrides:

getFailureStoreStatus in class DocWriteResponse

toString

public String toString()

Overrides:

toString in class Object