Skip to content

Commit

Permalink
docs(client): update description for WorkflowStubInterface::startUpda…
Browse files Browse the repository at this point in the history
…te() method (#429)
  • Loading branch information
roxblnfk authored May 10, 2024
1 parent 6e710e3 commit ab8a006
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/Client/WorkflowStubInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,14 @@ public function query(string $name, ...$args): ?ValuesInterface;
public function update(string $name, ...$args): ?ValuesInterface;

/**
* Asynchronously update a workflow execution by invoking its update handler and returning a
* Update a workflow execution by invoking its update handler and returning a
* handle to the update request.
*
* By default, WaitPolicy is set to {@see \Temporal\Client\Update\LifecycleStage::StageAccepted},
* which means that the handle will return immediately after successful validation of the Update call.
* However, also note that the processing Workflow worker must be available. Otherwise, the request
* may block indefinitely or fail due to a timeout.
*
* Usually an update handler is a method annotated with the {@see UpdateMethod} attribute.
*
* @param non-empty-string|UpdateOptions $nameOrOptions Name of the update handler or update options.
Expand Down

0 comments on commit ab8a006

Please sign in to comment.