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 Modifier and Type Field Description protected boolean
acknowledged
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addCustomFields(XContentBuilder builder, ToXContent.Params params)
protected static <T extends AcknowledgedResponse>
voiddeclareAcknowledgedField(ConstructingObjectParser<T,java.lang.Void> objectParser)
boolean
equals(java.lang.Object o)
int
hashCode()
boolean
isAcknowledged()
Returns whether the response is acknowledged or notprotected static boolean
parseAcknowledged(XContentParser parser)
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 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
-
-
-
-
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 interfaceStreamable
- Overrides:
readFrom
in classActionResponse
- 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 interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionResponse
- Throws:
java.io.IOException
-
toXContent
public final XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
addCustomFields
protected void addCustomFields(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Throws:
java.io.IOException
-
parseAcknowledged
protected static boolean parseAcknowledged(XContentParser parser)
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-