Package org.elasticsearch.action.support.replication

Class ReplicationTask

java.lang.Object
org.elasticsearch.tasks.Task
org.elasticsearch.action.support.replication.ReplicationTask
public class ReplicationTask
extends Task
Task that tracks replication actions.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ReplicationTask.Status  

  • Field Summary

    Fields inherited from class org.elasticsearch.tasks.Task

    X_OPAQUE_ID

  • Constructor Summary

    Constructors 
    Constructor Description
    ReplicationTask​(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTaskId, java.util.Map<java.lang.String,​java.lang.String> headers)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getPhase()
    Get the current phase of the task.
    ReplicationTask.Status getStatus()
    Build a status for this task or null if this task doesn't have status.
    void setPhase​(java.lang.String phase)
    Set the current phase of the task.

    Methods inherited from class org.elasticsearch.tasks.Task

    getAction, getDescription, getHeader, getId, getParentTaskId, getStartTime, getType, result, result, taskInfo, taskInfo

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ReplicationTask

      public ReplicationTask​(long id, java.lang.String type, java.lang.String action, java.lang.String description, TaskId parentTaskId, java.util.Map<java.lang.String,​java.lang.String> headers)

  • Method Details

    • setPhase

      public void setPhase​(java.lang.String phase)
      Set the current phase of the task.

    • getPhase

      public java.lang.String getPhase()
      Get the current phase of the task.

    • getStatus

      public ReplicationTask.Status getStatus()
      Description copied from class: Task
      Build a status for this task or null if this task doesn't have status. Since most tasks don't have status this defaults to returning null. While this can never perform IO it might be a costly operation, requiring collating lists of results, etc. So only use it if you need the value.
      Overrides:
      getStatus in class Task