Add comment that cluster state ACK waiting is the default

1 files changed, 9 insertions, 2 deletions

diff --git a/clustercontroller-utils/src/main/java/com/yahoo/vespa/clustercontroller/utils/staterestapi/requests/SetUnitStateRequest.java b/clustercontroller-utils/src/main/java/com/yahoo/vespa/clustercontroller/utils/staterestapi/requests/SetUnitStateRequest.java
index 5a9b85e734b..78552f62e06 100644
--- a/clustercontroller-utils/src/main/java/com/yahoo/vespa/clustercontroller/utils/staterestapi/requests/SetUnitStateRequest.java
+++ b/clustercontroller-utils/src/main/java/com/yahoo/vespa/clustercontroller/utils/staterestapi/requests/SetUnitStateRequest.java
@@ -31,8 +31,15 @@ public interface SetUnitStateRequest extends UnitRequest {
     Condition getCondition();
 
     enum ResponseWait {
-        WAIT_UNTIL_CLUSTER_ACKED("wait-until-cluster-acked"), // Wait for state change to be ACKed by cluster
-        NO_WAIT("no-wait"); // Return without waiting for state change to be ACKed by cluster
+        /**
+         * Wait for state change to be ACKed by cluster. Default unless request
+         * explicitly specifies otherwise.
+         */
+        WAIT_UNTIL_CLUSTER_ACKED("wait-until-cluster-acked"),
+        /**
+         * Return without waiting for state change to be ACKed by cluster.
+         */
+        NO_WAIT("no-wait");
 
         private final String name;