Repository navigation
Conversation
The startUpdate and startUpdateWithStart overloads documented the call as asynchronous. They actually return once the update reaches the wait-for stage set in UpdateOptions, so the call blocks until the update finishes when that stage is COMPLETED. Fixes temporalio#2578 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
The previous wording said startUpdate blocks until the update finishes when the wait-for stage is COMPLETED. The invoker stops re-polling once the update is at least accepted, so the call can return earlier with a handle that has no outcome yet. Describe the call as possibly blocking up to the server's wait limit and point callers at the returned handle for the remaining wait. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
sdjcse
force-pushed
the
issue-2578-startupdate-javadoc
branch
from
October 28, 2026 10:08
3ec9c41 to
0d81b32
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2578
What changed?
WorkflowClient.startUpdateandstartUpdateWithStartoverload (21 in total).UpdateOptions.Builder#setWaitForStage, up to the server's wait limit. If the update has not reached that stage by then, the call returns early and the returned handle can be used to wait for the result.Why?
startUpdatemakes a blocking gRPC call with the caller's wait policy, so withWorkflowUpdateStage.COMPLETEDit normally blocks until the update finishes. The "asynchronously" wording suggested it always returns immediately and onlygetResultwaits. The invoker stops re-polling once the update is at least accepted, so the wording says "may block" rather than guaranteeing completion.Breaking changes?
None. JavaDoc only, no signature or behavior changes.
Server PR
Not applicable.
🤖 Generated with Claude Code