-
Notifications
You must be signed in to change notification settings - Fork 224
Open
Milestone
Description
Align getInstanceState
and other instance
-based APIs with workflow
naming in Java SDK
In the Java SDK, the method for retrieving workflow state is currently named getInstanceState
:
Other SDKs, however, use a getWorkflowState
naming convention:
This creates inconsistency when developers work across SDKs or follow documentation.
Additionally, there are other places in the Java SDK where “instance” appears in API names. For example:
Other SDKs use “workflow” consistently for this concept, e.g. .NET has WaitForWorkflowStartAsync
.
Proposal
- Add an alias method
getWorkflowState
to the Java SDK alongside the existinggetInstanceState
. - Add an alias method
waitForInstanceStart
→waitForWorkflowStart
. - Mark
instance
-based methods for eventual deprecation, or update docs/samples to emphasize theworkflow
terminology for consistency.
Related issue
- Original discussion: Java Workflow client naming inconsistent with other Workflow SDKs #1012
Metadata
Metadata
Assignees
Labels
No labels