Package org.elasticsearch.action.support.master

Class AcknowledgedResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.master.AcknowledgedResponse

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject

Direct Known Subclasses:

CloseIndexResponse, ClusterRerouteResponse, ClusterUpdateSettingsResponse, DeleteIndexResponse, DeleteIndexTemplateResponse, DeleteRepositoryResponse, DeleteSnapshotResponse, DeleteStoredScriptResponse, IndicesAliasesResponse, PutIndexTemplateResponse, PutMappingResponse, PutRepositoryResponse, PutStoredScriptResponse, ShardsAcknowledgedResponse, UpdateSettingsResponse, UpgradeSettingsResponse, WritePipelineResponse

public abstract class AcknowledgedResponse
extends ActionResponse
implements ToXContentObject

Abstract class that allows to mark action responses that support acknowledgements. Facilitates consistency across different api.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

TransportResponse.Empty

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

Constructors

Modifier	Constructor	Description
protected	AcknowledgedResponse()
protected	AcknowledgedResponse(boolean acknowledged)

Method Summary

Modifier and Type	Method	Description
protected void	addCustomFields(XContentBuilder builder, ToXContent.Params params)
protected static <T extends AcknowledgedResponse> void	declareAcknowledgedField(ConstructingObjectParser<T,java.lang.Void> objectParser)
boolean	equals(java.lang.Object o)
int	hashCode()
boolean	isAcknowledged()	Returns whether the response is acknowledged or not
protected void	readAcknowledged(StreamInput in)	Reads the acknowledged value
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected void	writeAcknowledged(StreamOutput out)	Writes the acknowledged value

Methods inherited from class org.elasticsearch.action.ActionResponse

readFrom, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Constructor Detail

AcknowledgedResponse

protected AcknowledgedResponse()

AcknowledgedResponse

protected AcknowledgedResponse(boolean acknowledged)

Method Detail

declareAcknowledgedField

protected static <T extends AcknowledgedResponse> void declareAcknowledgedField(ConstructingObjectParser<T,java.lang.Void> objectParser)

isAcknowledged

public final boolean isAcknowledged()

Returns whether the response is acknowledged or not

Returns:

true if the response is acknowledged, false otherwise

readAcknowledged

protected void readAcknowledged(StreamInput in)
                         throws java.io.IOException

Reads the acknowledged value

Throws:

java.io.IOException

writeAcknowledged

protected void writeAcknowledged(StreamOutput out)
                          throws java.io.IOException

Writes the acknowledged value

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

addCustomFields

protected void addCustomFields(XContentBuilder builder,
                               ToXContent.Params params)
                        throws java.io.IOException

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object