Add comments

apache · Oct 27, 2023 · b941dd8 · b941dd8
1 parent efdd958
commit b941dd8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/...main/java/org/apache/helix/rest/clusterMaintenanceService/StoppableInstancesSelector.java b/...main/java/org/apache/helix/rest/clusterMaintenanceService/StoppableInstancesSelector.java
@@ -67,6 +67,10 @@ public StoppableInstancesSelector(String clusterId, List<String> orderOfZone,
    *
    * @param instances A list of instance to be evaluated.
    * @param toBeStoppedInstances A list of instances presumed to be are already stopped
+   * @return An ObjectNode containing:
+   *         - 'stoppableNode': List of instances that can be stopped.
+   *         - 'instance_not_stoppable_with_reasons': A map with the instance name as the key and
+   *         a list of reasons for non-stoppability as the value.
    * @throws IOException
    */
   public ObjectNode getStoppableInstancesInSingleZone(List<String> instances,
@@ -94,6 +98,10 @@ public ObjectNode getStoppableInstancesInSingleZone(List<String> instances,
    *
    * @param instances A list of instance to be evaluated.
    * @param toBeStoppedInstances A list of instances presumed to be are already stopped
+   * @return An ObjectNode containing:
+   *         - 'stoppableNode': List of instances that can be stopped.
+   *         - 'instance_not_stoppable_with_reasons': A map with the instance name as the key and
+   *         a list of reasons for non-stoppability as the value.
    * @throws IOException
    */
   public ObjectNode getStoppableInstancesCrossZones(List<String> instances,