Skip to content

Commit 96eb34e

Browse files
mcruzdevmcruzdev
committed
Align Java API with other languages
Signed-off-by: Matheus Cruz <[email protected]>
1 parent a7d426a commit 96eb34e

File tree

22 files changed

+968
-67
lines changed

22 files changed

+968
-67
lines changed

‎daprdocs/content/en/java-sdk-docs/java-client/_index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ public class DemoWorkflowClient {
514514

515515
System.out.println(separatorStr);
516516
System.out.println("**GetInstanceMetadata:Running Workflow**");
517-
WorkflowInstanceStatus workflowMetadata = client.getInstanceState(instanceId, true);
517+
WorkflowInstanceStatus workflowMetadata = client.getWorkflowState(instanceId, true);
518518
System.out.printf("Result: %s%n", workflowMetadata);
519519

520520
System.out.println(separatorStr);
@@ -545,13 +545,13 @@ public class DemoWorkflowClient {
545545

546546

547547
System.out.println(separatorStr);
548-
System.out.println("**WaitForInstanceCompletion**");
548+
System.out.println("**waitForWorkflowCompletion**");
549549
try {
550-
WorkflowInstanceStatus waitForInstanceCompletionResult =
551-
client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(60), true);
552-
System.out.printf("Result: %s%n", waitForInstanceCompletionResult);
550+
WorkflowInstanceStatus waitForWorkflowCompletionResult =
551+
client.waitForWorkflowCompletion(instanceId, Duration.ofSeconds(60), true);
552+
System.out.printf("Result: %s%n", waitForWorkflowCompletionResult);
553553
} catch (TimeoutException ex) {
554-
System.out.printf("waitForInstanceCompletion has an exception:%s%n", ex);
554+
System.out.printf("waitForWorkflowCompletion has an exception:%s%n", ex);
555555
}
556556

557557
System.out.println(separatorStr);

‎daprdocs/content/en/java-sdk-docs/java-workflow/java-workflow-howto.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public class DemoWorkflowClient {
104104

105105
System.out.println(separatorStr);
106106
System.out.println("**GetInstanceMetadata:Running Workflow**");
107-
WorkflowInstanceStatus workflowMetadata = client.getInstanceState(instanceId, true);
107+
WorkflowInstanceStatus workflowMetadata = client.getWorkflowState(instanceId, true);
108108
System.out.printf("Result: %s%n", workflowMetadata);
109109

110110
System.out.println(separatorStr);
@@ -135,13 +135,13 @@ public class DemoWorkflowClient {
135135

136136

137137
System.out.println(separatorStr);
138-
System.out.println("**WaitForInstanceCompletion**");
138+
System.out.println("**waitForWorkflowCompletion**");
139139
try {
140-
WorkflowInstanceStatus waitForInstanceCompletionResult =
141-
client.waitForInstanceCompletion(instanceId, Duration.ofSeconds(60), true);
142-
System.out.printf("Result: %s%n", waitForInstanceCompletionResult);
140+
WorkflowInstanceStatus waitForWorkflowCompletionResult =
141+
client.waitForWorkflowCompletion(instanceId, Duration.ofSeconds(60), true);
142+
System.out.printf("Result: %s%n", waitForWorkflowCompletionResult);
143143
} catch (TimeoutException ex) {
144-
System.out.printf("waitForInstanceCompletion has an exception:%s%n", ex);
144+
System.out.printf("waitForWorkflowCompletion has an exception:%s%n", ex);
145145
}
146146

147147
System.out.println(separatorStr);
@@ -213,7 +213,7 @@ Events raised for workflow with instanceId: 0b4cc0d5-413a-4c1c-816a-a71fa24740d4
213213
** Registering Event to be captured by anyOf(t1,t2,t3) **
214214
Event raised for workflow with instanceId: 0b4cc0d5-413a-4c1c-816a-a71fa24740d4
215215
*******
216-
**WaitForInstanceCompletion**
216+
**WaitForWorkflowCompletion**
217217
Result: [Name: 'io.dapr.examples.workflows.DemoWorkflow', ID: '0b4cc0d5-413a-4c1c-816a-a71fa24740d4', RuntimeStatus: FAILED, CreatedAt: 2023-09-13T13:02:30.547Z, LastUpdatedAt: 2023-09-13T13:02:55.054Z, Input: '"input data"', Output: '']
218218
*******
219219
**purgeInstance**

‎examples/src/main/java/io/dapr/examples/workflows/chain/DemoChainClient.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import io.dapr.examples.workflows.utils.PropertyUtils;
1717
import io.dapr.examples.workflows.utils.RetryUtils;
1818
import io.dapr.workflows.client.DaprWorkflowClient;
19-
import io.dapr.workflows.client.WorkflowInstanceStatus;
19+
import io.dapr.workflows.client.WorkflowState;
2020

2121
import java.time.Duration;
2222
import java.util.concurrent.TimeoutException;
@@ -34,10 +34,10 @@ public static void main(String[] args) {
3434
Duration.ofSeconds(60));
3535

3636
System.out.printf("Started a new chaining model workflow with instance ID: %s%n", instanceId);
37-
WorkflowInstanceStatus workflowInstanceStatus =
38-
client.waitForInstanceCompletion(instanceId, null, true);
37+
WorkflowState workflowState =
38+
client.waitForWorkflowCompletion(instanceId, null, true);
3939

40-
String result = workflowInstanceStatus.readOutputAs(String.class);
40+
String result = workflowState.readOutputAs(String.class);
4141
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
4242
} catch (TimeoutException | InterruptedException e) {
4343
throw new RuntimeException(e);

‎examples/src/main/java/io/dapr/examples/workflows/childworkflow/DemoChildWorkerflowClient.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
import io.dapr.examples.workflows.utils.PropertyUtils;
1717
import io.dapr.workflows.client.DaprWorkflowClient;
18-
import io.dapr.workflows.client.WorkflowInstanceStatus;
18+
import io.dapr.workflows.client.WorkflowState;
1919

2020
import java.util.concurrent.TimeoutException;
2121

@@ -30,10 +30,10 @@ public static void main(String[] args) {
3030
try (DaprWorkflowClient client = new DaprWorkflowClient(PropertyUtils.getProperties(args))) {
3131
String instanceId = client.scheduleNewWorkflow(DemoWorkflow.class);
3232
System.out.printf("Started a new child-workflow model workflow with instance ID: %s%n", instanceId);
33-
WorkflowInstanceStatus workflowInstanceStatus =
34-
client.waitForInstanceCompletion(instanceId, null, true);
33+
WorkflowState workflowState =
34+
client.waitForWorkflowCompletion(instanceId, null, true);
3535

36-
String result = workflowInstanceStatus.readOutputAs(String.class);
36+
String result = workflowState.readOutputAs(String.class);
3737
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId, result);
3838

3939
} catch (TimeoutException | InterruptedException e) {

‎examples/src/main/java/io/dapr/examples/workflows/compensation/BookTripClient.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import io.dapr.examples.workflows.utils.PropertyUtils;
1717
import io.dapr.examples.workflows.utils.RetryUtils;
1818
import io.dapr.workflows.client.DaprWorkflowClient;
19-
import io.dapr.workflows.client.WorkflowInstanceStatus;
19+
import io.dapr.workflows.client.WorkflowState;
2020

2121
import java.time.Duration;
2222
import java.util.concurrent.TimeoutException;
@@ -27,7 +27,7 @@ public static void main(String[] args) {
2727
String instanceId = RetryUtils.callWithRetry(() -> client.scheduleNewWorkflow(BookTripWorkflow.class), Duration.ofSeconds(60));
2828
System.out.printf("Started a new trip booking workflow with instance ID: %s%n", instanceId);
2929

30-
WorkflowInstanceStatus status = client.waitForInstanceCompletion(instanceId, Duration.ofMinutes(30), true);
30+
WorkflowState status = client.waitForWorkflowCompletion(instanceId, Duration.ofMinutes(30), true);
3131
System.out.printf("Workflow instance with ID: %s completed with status: %s%n", instanceId, status);
3232
System.out.printf("Workflow output: %s%n", status.getSerializedOutput());
3333
} catch (TimeoutException | InterruptedException e) {

‎examples/src/main/java/io/dapr/examples/workflows/continueasnew/DemoContinueAsNewClient.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public static void main(String[] args) {
3030
String instanceId = client.scheduleNewWorkflow(DemoContinueAsNewWorkflow.class);
3131
System.out.printf("Started a new continue-as-new model workflow with instance ID: %s%n", instanceId);
3232

33-
client.waitForInstanceCompletion(instanceId, null, true);
33+
client.waitForWorkflowCompletion(instanceId, null, true);
3434
System.out.printf("workflow instance with ID: %s completed.", instanceId);
3535

3636
} catch (TimeoutException | InterruptedException e) {

‎examples/src/main/java/io/dapr/examples/workflows/externalevent/DemoExternalEventClient.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public static void main(String[] args) {
3333
client.raiseEvent(instanceId, "Approval", true);
3434
//client.raiseEvent(instanceId, "Approval", false);
3535

36-
client.waitForInstanceCompletion(instanceId, null, true);
36+
client.waitForWorkflowCompletion(instanceId, null, true);
3737
System.out.printf("workflow instance with ID: %s completed.", instanceId);
3838

3939
} catch (TimeoutException | InterruptedException e) {

‎examples/src/main/java/io/dapr/examples/workflows/faninout/DemoFanInOutClient.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import io.dapr.examples.workflows.utils.PropertyUtils;
1717
import io.dapr.examples.workflows.utils.RetryUtils;
1818
import io.dapr.workflows.client.DaprWorkflowClient;
19-
import io.dapr.workflows.client.WorkflowInstanceStatus;
19+
import io.dapr.workflows.client.WorkflowState;
2020

2121
import java.time.Duration;
2222
import java.util.Arrays;
@@ -48,12 +48,12 @@ public static void main(String[] args) throws InterruptedException {
4848
System.out.printf("Started a new fan out/fan in model workflow with instance ID: %s%n", instanceId);
4949

5050
// Block until the orchestration completes. Then print the final status, which includes the output.
51-
WorkflowInstanceStatus workflowInstanceStatus = client.waitForInstanceCompletion(
51+
WorkflowState workflowState = client.waitForWorkflowCompletion(
5252
instanceId,
5353
Duration.ofSeconds(30),
5454
true);
5555
System.out.printf("workflow instance with ID: %s completed with result: %s%n", instanceId,
56-
workflowInstanceStatus.readOutputAs(int.class));
56+
workflowState.readOutputAs(int.class));
5757
} catch (TimeoutException e) {
5858
throw new RuntimeException(e);
5959
}

‎examples/src/main/java/io/dapr/examples/workflows/multiapp/MultiAppWorkflowClient.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
package io.dapr.examples.workflows.multiapp;
1515

1616
import io.dapr.workflows.client.DaprWorkflowClient;
17-
import io.dapr.workflows.client.WorkflowInstanceStatus;
17+
import io.dapr.workflows.client.WorkflowState;
1818

1919
import java.util.concurrent.TimeoutException;
2020

@@ -48,8 +48,8 @@ public static void main(String[] args) {
4848

4949
// Wait for the workflow to complete
5050
System.out.println("Waiting for workflow completion...");
51-
WorkflowInstanceStatus workflowInstanceStatus =
52-
client.waitForInstanceCompletion(instanceId, null, true);
51+
WorkflowState workflowInstanceStatus =
52+
client.waitForWorkflowCompletion(instanceId, null, true);
5353

5454
// Get the result
5555
String result = workflowInstanceStatus.readOutputAs(String.class);

‎examples/src/main/java/io/dapr/examples/workflows/suspendresume/DemoSuspendResumeClient.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import io.dapr.examples.workflows.utils.PropertyUtils;
1818
import io.dapr.examples.workflows.utils.RetryUtils;
1919
import io.dapr.workflows.client.DaprWorkflowClient;
20-
import io.dapr.workflows.client.WorkflowInstanceStatus;
20+
import io.dapr.workflows.client.WorkflowState;
2121

2222
import java.time.Duration;
2323
import java.util.concurrent.TimeoutException;
@@ -38,21 +38,21 @@ public static void main(String[] args) {
3838
System.out.printf("Suspending Workflow Instance: %s%n", instanceId );
3939
client.suspendWorkflow(instanceId, "suspending workflow instance.");
4040

41-
WorkflowInstanceStatus instanceState = client.getInstanceState(instanceId, false);
41+
WorkflowState instanceState = client.getWorkflowState(instanceId, false);
4242
assert instanceState != null;
4343
System.out.printf("Workflow Instance Status: %s%n", instanceState.getRuntimeStatus().name() );
4444

4545
System.out.printf("Let's resume the Workflow Instance before sending the external event: %s%n", instanceId );
4646
client.resumeWorkflow(instanceId, "resuming workflow instance.");
4747

48-
instanceState = client.getInstanceState(instanceId, false);
48+
instanceState = client.getWorkflowState(instanceId, false);
4949
assert instanceState != null;
5050
System.out.printf("Workflow Instance Status: %s%n", instanceState.getRuntimeStatus().name() );
5151

5252
System.out.printf("Now that the instance is RUNNING again, lets send the external event. %n");
5353
client.raiseEvent(instanceId, "Approval", true);
5454

55-
client.waitForInstanceCompletion(instanceId, null, true);
55+
client.waitForWorkflowCompletion(instanceId, null, true);
5656
System.out.printf("workflow instance with ID: %s completed.", instanceId);
5757

5858
} catch (TimeoutException | InterruptedException e) {

0 commit comments

Comments
 (0)