Module org.elasticsearch.server

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:

Writeable, RefCounted, 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.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 boolean	acknowledged
static final AcknowledgedResponse	FALSE
static final AcknowledgedResponse	TRUE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addCustomFields(XContentBuilder builder, ToXContent.Params params)
protected static <T extends AcknowledgedResponse> void	declareAcknowledgedField(ConstructingObjectParser<T,Void> objectParser)
boolean	equals(Object o)
static AcknowledgedResponse	fromXContent(XContentParser parser)
int	hashCode()
final boolean	isAcknowledged()	Returns whether the response is acknowledged or not
static AcknowledgedResponse	of(boolean acknowledged)
static AcknowledgedResponse	readFrom(StreamInput in)
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

TRUE

public static final AcknowledgedResponse TRUE

FALSE

public static final AcknowledgedResponse FALSE

acknowledged

protected final boolean acknowledged

Constructor Details

AcknowledgedResponse

protected AcknowledgedResponse(StreamInput in)
                        throws IOException

Throws:

IOException

AcknowledgedResponse

protected AcknowledgedResponse(boolean acknowledged)

Method Details

declareAcknowledgedField

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

readFrom

public static AcknowledgedResponse readFrom(StreamInput in)
                                     throws IOException

Throws:

IOException

of

public static AcknowledgedResponse of(boolean acknowledged)

isAcknowledged

public final boolean isAcknowledged()

Returns whether the response is acknowledged or not

Returns:

true if the response is acknowledged, false otherwise

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

addCustomFields

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

Throws:

IOException

fromXContent

public static AcknowledgedResponse fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object