Skip to content
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

Tweak UpdateWorfklow docs #1745

Merged
merged 3 commits into from
Dec 6, 2024
Merged

Tweak UpdateWorfklow docs #1745

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ae92c1
Tweak UpdateWorfklow docs
dandavison Dec 5, 2024
8191ac8
"worker service" => "a worker"
dandavison Dec 5, 2024
0031f04
Merge branch 'master' into update-docs
dandavison Dec 6, 2024
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
18 changes: 10 additions & 8 deletions client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -831,14 +831,16 @@ type (
// API. If the check fails, an error is returned.
CheckHealth(ctx context.Context, request *CheckHealthRequest) (*CheckHealthResponse, error)

// UpdateWorkflow issues an update request to the
// specified workflow execution and returns a handle to the update that
// is running in in parallel with the calling thread. Errors returned
// from the server will be exposed through the return value of
// WorkflowUpdateHandle.Get(). Errors that occur before the
// update is requested (e.g. if the required workflow ID field is
// missing from the UpdateWorkflowOptions) are returned
// directly from this function call.
// UpdateWorkflow issues an update request to the specified workflow and
// returns a handle to the update. The call will block until the update
// has reached the WaitForStage in the options. Note that this means
// that the call will not return successfully until the update has been
// delivered to a worker. Errors returned from the update handler or its
// validator will be exposed through the return value of
// WorkflowUpdateHandle.Get(). Errors that occur before the update is
// delivered to the workflow (e.g. if the required workflow ID field is
// missing from the UpdateWorkflowOptions) are returned directly from
// this function call.
//
// The errors it can return:
// - WorkflowUpdateServiceTimeoutOrCanceledError
Expand Down
Loading