Class AcknowledgedResponse

All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
Direct Known Subclasses:
ClusterRerouteResponse, ClusterUpdateSettingsResponse, ShardsAcknowledgedResponse

public class AcknowledgedResponse
extends ActionResponse
implements org.elasticsearch.common.xcontent.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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    protected static <T extends AcknowledgedResponse>
    void
    declareAcknowledgedField​(org.elasticsearch.common.xcontent.ConstructingObjectParser<T,​java.lang.Void> objectParser)  
    boolean equals​(java.lang.Object o)  
    static AcknowledgedResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    int hashCode()  
    boolean isAcknowledged()
    Returns whether the response is acknowledged or not
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the 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 Details

  • Constructor Details

  • Method Details

    • declareAcknowledgedField

      protected static <T extends AcknowledgedResponse> void declareAcknowledgedField​(org.elasticsearch.common.xcontent.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
    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException
    • toXContent

      public final org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException
    • addCustomFields

      protected void addCustomFields​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Throws:
      java.io.IOException
    • fromXContent

      public static AcknowledgedResponse fromXContent​(org.elasticsearch.common.xcontent.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