Adds note about workflow start time (#1444)

JoshVanL · dapr-bot · artur-ciocanu · web-flow · commit 7bb5ffccf154 · 2025-07-14T10:02:01.000-07:00
Signed-off-by: joshvanl &lt;me@joshvanl.dev&gt;
Co-authored-by: Dapr Bot &lt;56698301+dapr-bot@users.noreply.github.com&gt;
Co-authored-by: artur-ciocanu &lt;artur.ciocanu@gmail.com&gt;
diff --git a/sdk-workflows/src/main/java/io/dapr/workflows/client/NewWorkflowOptions.java b/sdk-workflows/src/main/java/io/dapr/workflows/client/NewWorkflowOptions.java
@@ -63,8 +63,10 @@ public NewWorkflowOptions setInput(Object input) {
   /**
    * Sets the start time of the new workflow.
    *
-   * <p>By default, new workflow instances start executing immediately. This method can be used
-   * to start them at a specific time in the future.
+   * <p>By default, new workflow instances start executing immediately. This
+   * method can be used to start them at a specific time in the future. If set,
+   * Dapr will not wait for the workflow to "start" which can improve
+   * throughput of creating many workflows.
    *
    * @param startTime the start time of the new workflow
    * @return this {@link NewWorkflowOptions} object

Original file line number	Diff line number	Diff line change
`@@ -63,8 +63,10 @@ public NewWorkflowOptions setInput(Object input) {`
`63`	`63`	`/**`
`64`	`64`	`* Sets the start time of the new workflow.`
`65`	`65`	`*`
`66`		`- * <p>By default, new workflow instances start executing immediately. This method can be used`
`67`		`- * to start them at a specific time in the future.`
	`66`	`+ * <p>By default, new workflow instances start executing immediately. This`
	`67`	`+ * method can be used to start them at a specific time in the future. If set,`
	`68`	`+ * Dapr will not wait for the workflow to "start" which can improve`
	`69`	`+ * throughput of creating many workflows.`
`68`	`70`	`*`
`69`	`71`	`* @param startTime the start time of the new workflow`
`70`	`72`	`* @return this {@link NewWorkflowOptions} object`