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:

ClusterRerouteResponse, ClusterUpdateSettingsResponse, ShardsAcknowledgedResponse

public class AcknowledgedResponse
extends ActionResponse
implements ToXContentObject

A response that indicates that a request has been acknowledged

Nested Class Summary

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

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 boolean	acknowledged

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AcknowledgedResponse(boolean acknowledged)
AcknowledgedResponse(StreamInput in)
AcknowledgedResponse(StreamInput in, boolean readAcknowledged)

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)
static AcknowledgedResponse	fromXContent(XContentParser parser)
int	hashCode()
boolean	isAcknowledged()	Returns whether the response is acknowledged or not
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

acknowledged

protected boolean acknowledged

Constructor Detail

AcknowledgedResponse

public AcknowledgedResponse(StreamInput in)
                     throws java.io.IOException

Throws:

java.io.IOException

AcknowledgedResponse

public AcknowledgedResponse(StreamInput in,
                            boolean readAcknowledged)
                     throws java.io.IOException

Throws:

java.io.IOException

AcknowledgedResponse

public 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

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

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

fromXContent

public static AcknowledgedResponse fromXContent(XContentParser parser)
                                         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