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 existing getInstanceState.
- Add an alias method
waitForInstanceStart → waitForWorkflowStart.
- Mark
instance-based methods for eventual deprecation, or update docs/samples to emphasize the workflow terminology for consistency.
Related issue
Align
getInstanceStateand otherinstance-based APIs withworkflownaming in Java SDKIn the Java SDK, the method for retrieving workflow state is currently named
getInstanceState:getInstanceStateOther SDKs, however, use a
getWorkflowStatenaming convention:GetWorkflowStateAsyncget_workflow_stateThis 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:
waitForInstanceStartOther SDKs use “workflow” consistently for this concept, e.g. .NET has
WaitForWorkflowStartAsync.Proposal
getWorkflowStateto the Java SDK alongside the existinggetInstanceState.waitForInstanceStart→waitForWorkflowStart.instance-based methods for eventual deprecation, or update docs/samples to emphasize theworkflowterminology for consistency.Related issue