Skip to content

[docs] Add workflows to .NET client doc #1019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
halspang merged 11 commits into from
Feb 8, 2023
Merged

[docs] Add workflows to .NET client doc #1019

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2d52c00
add workflows to client page
hhunter-ms Feb 1, 2023
24b8450
update title per Chris
hhunter-ms Feb 1, 2023
49cc32e
update from Ryan
hhunter-ms Feb 2, 2023
0c22791
Merge branch 'master' into issue_1016
hhunter-ms Feb 6, 2023
8e23b8e
Merge branch 'master' of https://github.com/dapr/dotnet-sdk into issu…
hhunter-ms Feb 6, 2023
dffa664
update per Ryan
hhunter-ms Feb 6, 2023
d6824ad
Merge branch 'issue_1016' of https://github.com/hhunter-ms/dotnet-sdk…
hhunter-ms Feb 6, 2023
dbf6f68
remove workflow options and cts
hhunter-ms Feb 7, 2023
b6f8cbc
remove default
hhunter-ms Feb 7, 2023
dc1abfd
update per Chris; make consistent
hhunter-ms Feb 8, 2023
baf1a0b
ope - forgot the input update
hhunter-ms Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions daprdocs/content/en/dotnet-sdk-docs/dotnet-client/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,33 @@ await foreach (var items in subscribeConfigurationResponse.Source.WithCancellati
}
```

### Manage workflow instances (Alpha)

```csharp
var daprClient = new DaprClientBuilder().Build();

string instanceId = "MyWorkflowInstance1";
string workflowComponentName = "dapr"; // alternatively, this could be the name of a workflow component defined in yaml
string workflowName = "MyWorkflowDefinition";
var input = new { name = "Billy", age = 30 }; // Any JSON-serializable value is OK

// Start workflow
Copy link
Copy Markdown
Contributor

@RyanLettieri RyanLettieri Feb 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string instanceId;
string workflowComponentName;
string workflowName;
object input ;

It might be helpful to add all of these above "//Start workflow" to give the user a better idea as to what variable types everything is.

Copy link
Copy Markdown
Contributor

@cgillum cgillum Feb 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't bother with a CancellationToken cts local variable. Just pass CancellationToken.None directly as the last input of StartWorkflowAsync.

Copy link
Copy Markdown
Contributor

@halspang halspang Feb 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're using CancellationToken.None I'd rather just use the default variable. I worry that this implies that you have to use a CancellationToken instead of having it as optional.

Copy link
Copy Markdown
Contributor

@cgillum cgillum Feb 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, good point. In that case, let’s remove both the options variable and the cancellation token.

var startResponse = await daprClient.StartWorkflowAsync(instanceId, workflowComponentName, workflowName, input);

// Terminate workflow
await daprClient.TerminateWorkflowAsync(instanceId, workflowComponentName);

// Get workflow metadata
var getResponse = await daprClient.GetWorkflowAsync(instanceId, workflowComponentName, workflowName);
```

## Sidecar APIs
### Sidecar Health
The .NET SDK provides a way to poll for the sidecar health, as well as a convenience method to wait for the sidecar to be ready.

#### Poll for health
This health endpoint returns true when both the sidecar and your application are up (fully initialized).

```csharp
var client = new DaprClientBuilder().Build();

Expand Down