Skip to content

Align getInstanceState and other instance-based APIs with workflow naming #1554

@cicoyle

Description

@cicoyle

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 waitForInstanceStartwaitForWorkflowStart.
  • Mark instance-based methods for eventual deprecation, or update docs/samples to emphasize the workflow terminology for consistency.

Related issue

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions