Javadocs

jasontedor · Jan 24, 2019 · 0496d83 · 0496d83
1 parent 44f8afa
commit 0496d83
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/server/src/main/java/org/elasticsearch/index/seqno/RetentionLeaseSyncAction.java b/server/src/main/java/org/elasticsearch/index/seqno/RetentionLeaseSyncAction.java
@@ -87,6 +87,13 @@ public RetentionLeaseSyncAction(
                 ThreadPool.Names.MANAGEMENT);
     }
 
+    /**
+     * Sync the specified retention leases for the specified shard. The callback is invoked when the sync succeeds or fails.
+     *
+     * @param shardId         the shard to sync
+     * @param retentionLeases the retention leases to sync
+     * @param listener        the callbak to invoke when the sync completes normally or abnormally
+     */
     public void updateRetentionLeaseForShard(
             final ShardId shardId,
             final Collection<RetentionLease> retentionLeases,