Class AcknowledgedRequest<Request extends MasterNodeRequest<Request>>

All Implemented Interfaces:
AckedRequest, Writeable, org.elasticsearch.common.util.concurrent.RefCounted, TaskAwareRequest
Direct Known Subclasses:
AddIndexBlockRequest, CleanupRepositoryRequest, CloseIndexRequest, ClusterRerouteRequest, ClusterUpdateSettingsRequest, CreateIndexRequest, DeleteDanglingIndexRequest, DeleteIndexRequest, DeletePipelineRequest, DeleteRepositoryRequest, DeleteStoredScriptRequest, ImportDanglingIndexRequest, IndicesAliasesRequest, OpenIndexRequest, PutMappingRequest, PutPipelineRequest, PutRepositoryRequest, PutStoredScriptRequest, ResizeRequest, RolloverRequest, UpdateSettingsRequest, UpgradeSettingsRequest, VerifyRepositoryRequest

public abstract class AcknowledgedRequest<Request extends MasterNodeRequest<Request>>
extends MasterNodeRequest<Request>
implements AckedRequest
Abstract class that allows to mark action requests that support acknowledgements. Facilitates consistency across different api.
  • Field Details

    • DEFAULT_ACK_TIMEOUT

      public static final org.elasticsearch.common.unit.TimeValue DEFAULT_ACK_TIMEOUT
    • timeout

      protected org.elasticsearch.common.unit.TimeValue timeout
  • Constructor Details

    • AcknowledgedRequest

      protected AcknowledgedRequest()
    • AcknowledgedRequest

      protected AcknowledgedRequest​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
  • Method Details

    • timeout

      public final Request timeout​(java.lang.String timeout)
      Allows to set the timeout
      Parameters:
      timeout - timeout as a string (e.g. 1s)
      Returns:
      the request itself
    • timeout

      public final Request timeout​(org.elasticsearch.common.unit.TimeValue timeout)
      Allows to set the timeout
      Parameters:
      timeout - timeout as a TimeValue
      Returns:
      the request itself
    • timeout

      public final org.elasticsearch.common.unit.TimeValue timeout()
      Returns the current timeout
      Returns:
      the current timeout as a TimeValue
    • ackTimeout

      public org.elasticsearch.common.unit.TimeValue ackTimeout()
      Description copied from interface: AckedRequest
      Returns the acknowledgement timeout
      Specified by:
      ackTimeout in interface AckedRequest
    • 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
      Overrides:
      writeTo in class MasterNodeRequest<Request extends MasterNodeRequest<Request>>
      Throws:
      java.io.IOException