Class RecoveryRequest

All Implemented Interfaces:
IndicesRequest, IndicesRequest.Replaceable, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest

public class RecoveryRequest extends BroadcastRequest<RecoveryRequest>
Request for recovery information
  • Constructor Details

    • RecoveryRequest

      public RecoveryRequest()
      Constructs a request for recovery information for all shards
    • RecoveryRequest

      public RecoveryRequest(StreamInput in) throws IOException
      Throws:
      IOException
    • RecoveryRequest

      public RecoveryRequest(String... indices)
      Constructs a request for recovery information for all shards for the given indices
      Parameters:
      indices - Comma-separated list of indices about which to gather recovery information
  • Method Details

    • detailed

      public boolean detailed()
      True if detailed flag is set, false otherwise. This value if false by default.
      Returns:
      True if detailed flag is set, false otherwise
    • detailed

      public void detailed(boolean detailed)
      Set value of the detailed flag. Detailed requests will contain extra information such as a list of physical files and their recovery progress.
      Parameters:
      detailed - Whether or not to set the detailed flag
    • activeOnly

      public boolean activeOnly()
      True if activeOnly flag is set, false otherwise. This value is false by default.
      Returns:
      True if activeOnly flag is set, false otherwise
    • activeOnly

      public void activeOnly(boolean activeOnly)
      Set value of the activeOnly flag. If true, this request will only response with on-going recovery information.
      Parameters:
      activeOnly - Whether or not to set the activeOnly flag.
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Overrides:
      writeTo in class BroadcastRequest<RecoveryRequest>
      Throws:
      IOException
    • createTask

      public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)
      Description copied from interface: TaskAwareRequest
      Returns the task object that should be used to keep track of the processing of the request.