Address PR comments

Signed-off-by: Sachin Kale <[email protected]>
opensearch-project · Jul 26, 2023 · 5b3df83 · 5b3df83
1 parent 0c2dca3
commit 5b3df83
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/...va/org/opensearch/action/admin/cluster/remotestore/restore/RestoreRemoteStoreRequest.java b/...va/org/opensearch/action/admin/cluster/remotestore/restore/RestoreRemoteStoreRequest.java
@@ -122,9 +122,10 @@ public boolean waitForCompletion() {
     }
 
     /**
-     * If this parameter is set to true the operation will restore all the shards of the given indices
+     * Set the value for restoreAllShards, denoting whether to restore all shards or only unassigned shards
      *
-     * @param restoreAllShards if true the operation will restore all the shards
+     * @param restoreAllShards If true, the operation will restore all the shards of the given indices.
+     *                         If false, the operation will restore only the unassigned shards of the given indices.
      * @return this request
      */
     public RestoreRemoteStoreRequest restoreAllShards(boolean restoreAllShards) {