Description
The Java SDK Workflow naming is inconsistent with the other SDKs.
For example Currently the Workflow SDK has schedule
for Java
String instanceId = client.scheduleNewWorkflow(DemoWorkflow.class, "input data");
when the other SDKs have start
. For example .NET
StartWorkflowResponse startResponse = await daprClient.StartWorkflowAsync(orderId, workflowComponent, workflowName, input, workflowOptions);
and Python
start_resp = d.start_workflow(instance_id=instanceId, workflow_component=workflowComponent,
workflow_name=workflowName, input=inputData, workflow_options=workflowOptions)
Hence
scheduleNewWorkflow
should be renamed to startWorkflow
As another example Java SDK uses 'instance' everywhere and this is inconsistent with using 'workflow' in other SDKs.
// Get status information on the workflow
WorkflowInstanceStatus workflowMetadata = client.getInstanceState(instanceId, true);
as opposed to .NET
// Get information on the workflow. This response contains information such as the status of the workflow, when it started, and more!
GetWorkflowResponse getResponse = await daprClient.GetWorkflowAsync(orderId, workflowComponent, eventName);
and Python
# Get info on the workflow
getResponse = d.get_workflow(instance_id=instanceId, workflow_component=workflowComponent)
The docs in both the Java SDK and the Doc repo here https://docs.dapr.io/developing-applications/building-blocks/workflow/howto-manage-workflow/ will also need to be updated with this change