Skip to content

Add completed_by_worker_shutdown field to poll responses #730

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

Open
rkannan82 wants to merge 4 commits into
base: master
Choose a base branch
from
+34 −0
Open

Add completed_by_worker_shutdown field to poll responses #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c9726cb
Add shutdown_worker_rejected field to poll responses
rkannan82 Mar 17, 2026
67891ac
Merge branch 'master' into kannan/poll-shutdown-rejected-field
rkannan82 Apr 10, 2026
4fca164
Rename shutdown_worker_rejected to completed_by_worker_shutdown
rkannan82 Apr 10, 2026
d3b45e9
Regenerate openapi specs
rkannan82 Apr 10, 2026
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
4 changes: 4 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15355,6 +15355,10 @@
"pollerScalingDecision": {
"$ref": "#/definitions/v1PollerScalingDecision",
"description": "Server-advised information the SDK may use to adjust its poller count."
},
"completedByWorkerShutdown": {
"type": "boolean",
"description": "When true, this empty response was caused by the server completing the poll\nbecause the worker has been shut down via the ShutdownWorker API. The SDK\nshould stop polling on this task queue.\n"
}
}
},
Expand Down
9 changes: 9 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12220,6 +12220,15 @@ components:
allOf:
- $ref: '#/components/schemas/PollerScalingDecision'
description: Server-advised information the SDK may use to adjust its poller count.
completedByWorkerShutdown:
type: boolean
description: |-
When true, this empty response was caused by the server completing the poll
because the worker has been shut down via the ShutdownWorker API. The SDK
should stop polling on this task queue.

(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "by" describes the cause of poll completion. --)
PollerInfo:
type: object
properties:
Expand Down
21 changes: 21 additions & 0 deletions temporal/api/workflowservice/v1/request_response.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,13 @@ message PollWorkflowTaskQueueResponse {
repeated temporal.api.protocol.v1.Message messages = 15;
// Server-advised information the SDK may use to adjust its poller count.
temporal.api.taskqueue.v1.PollerScalingDecision poller_scaling_decision = 16;
// When true, this empty response was caused by the server completing the poll
// because the worker has been shut down via the ShutdownWorker API. The SDK
// should stop polling on this task queue.
//
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: "by" describes the cause of poll completion. --)
bool completed_by_worker_shutdown = 17;
}

message RespondWorkflowTaskCompletedRequest {
Expand Down Expand Up @@ -536,6 +543,13 @@ message PollActivityTaskQueueResponse {
temporal.api.common.v1.Priority priority = 19;
// The run ID of the activity execution, only set for standalone activities.
string activity_run_id = 20;
// When true, this empty response was caused by the server completing the poll
// because the worker has been shut down via the ShutdownWorker API. The SDK
// should stop polling on this task queue.
//
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: "by" describes the cause of poll completion. --)
bool completed_by_worker_shutdown = 21;
}

message RecordActivityTaskHeartbeatRequest {
Expand Down Expand Up @@ -1923,6 +1937,13 @@ message PollNexusTaskQueueResponse {
temporal.api.nexus.v1.Request request = 2;
// Server-advised information the SDK may use to adjust its poller count.
temporal.api.taskqueue.v1.PollerScalingDecision poller_scaling_decision = 3;
// When true, this empty response was caused by the server completing the poll
// because the worker has been shut down via the ShutdownWorker API. The SDK
// should stop polling on this task queue.
//
// (-- api-linter: core::0140::prepositions=disabled
// aip.dev/not-precedent: "by" describes the cause of poll completion. --)
bool completed_by_worker_shutdown = 4;
}

message RespondNexusTaskCompletedRequest {
Expand Down
Loading