Skip to content

Add poller group info to DescribeNamespace #788

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
ShahabT merged 2 commits into from
May 28, 2026
Merged

Add poller group info to DescribeNamespace #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87a3d0d
Add poller group info to DescribeNamespace
ShahabT May 26, 2026
40a9548
Merge branch 'master' into shahab/pginfo
ShahabT May 28, 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
20 changes: 14 additions & 6 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2621,7 +2621,7 @@
},
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
"get": {
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nWill be removed in server version v1.32.0.\nFetches the worker build id versioning sets for a task queue.",
"operationId": "GetWorkerBuildIdCompatibility2",
"responses": {
"200": {
Expand Down Expand Up @@ -2667,7 +2667,7 @@
},
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
"get": {
"summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.",
"summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWill be removed in server version v1.32.0.",
"operationId": "GetWorkerVersioningRules2",
"responses": {
"200": {
Expand Down Expand Up @@ -3376,7 +3376,7 @@
},
"/api/v1/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
"summary": "Deprecated. Use `DescribeTaskQueue`.\nWill be removed in server version v1.32.0.",
"description": "Fetches task reachability to determine whether a worker may be retired.\nThe request may specify task queues to query for or let the server fetch all task queues mapped to the given\nbuild IDs.\n\nWhen requesting a large number of task queues or all task queues associated with the given build ids in a\nnamespace, all task queues will be listed in the response but some of them may not contain reachability\ninformation due to a server enforced limit. When reaching the limit, task queues that reachability information\ncould not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue\nanother call to get the reachability for those task queues.\n\nOpen source users can adjust this limit by setting the server's dynamic config value for\n`limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.",
"operationId": "GetWorkerTaskReachability2",
"responses": {
Expand Down Expand Up @@ -8135,7 +8135,7 @@
},
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-build-id-compatibility": {
"get": {
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nFetches the worker build id versioning sets for a task queue.",
"summary": "Deprecated. Use `GetWorkerVersioningRules`.\nWill be removed in server version v1.32.0.\nFetches the worker build id versioning sets for a task queue.",
"operationId": "GetWorkerBuildIdCompatibility",
"responses": {
"200": {
Expand Down Expand Up @@ -8181,7 +8181,7 @@
},
"/namespaces/{namespace}/task-queues/{taskQueue}/worker-versioning-rules": {
"get": {
"summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.",
"summary": "Fetches the Build ID assignment and redirect rules for a Task Queue.\nWill be removed in server version v1.32.0.",
"operationId": "GetWorkerVersioningRules",
"responses": {
"200": {
Expand Down Expand Up @@ -8851,7 +8851,7 @@
},
"/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
"summary": "Deprecated. Use `DescribeTaskQueue`.\nWill be removed in server version v1.32.0.",
"description": "Fetches task reachability to determine whether a worker may be retired.\nThe request may specify task queues to query for or let the server fetch all task queues mapped to the given\nbuild IDs.\n\nWhen requesting a large number of task queues or all task queues associated with the given build ids in a\nnamespace, all task queues will be listed in the response but some of them may not contain reachability\ninformation due to a server enforced limit. When reaching the limit, task queues that reachability information\ncould not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue\nanother call to get the reachability for those task queues.\n\nOpen source users can adjust this limit by setting the server's dynamic config value for\n`limit.reachabilityTaskQueueScan` with the caveat that this call can strain the visibility store.",
"operationId": "GetWorkerTaskReachability",
"responses": {
Expand Down Expand Up @@ -15036,6 +15036,14 @@
"$ref": "#/definitions/v1FailoverStatus"
},
"description": "Contains the historical state of failover_versions for the cluster, truncated to contain only the last N\nstates to ensure that the list does not grow unbounded."
},
"pollerGroupInfos": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1PollerGroupInfo"
},
"description": "The initial info that client should use for poller group assignment. This information is\nupdated through poll response. Client is supposed to use the info received in the latest\npoll response."
}
}
},
Expand Down
16 changes: 14 additions & 2 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2229,6 +2229,7 @@ paths:
- WorkflowService
description: |-
Deprecated. Use `GetWorkerVersioningRules`.
Will be removed in server version v1.32.0.
Fetches the worker build id versioning sets for a task queue.
operationId: GetWorkerBuildIdCompatibility
parameters:
Expand Down Expand Up @@ -2270,7 +2271,7 @@ paths:
- WorkflowService
description: |-
Fetches the Build ID assignment and redirect rules for a Task Queue.
WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
Will be removed in server version v1.32.0.
operationId: GetWorkerVersioningRules
parameters:
- name: namespace
Expand Down Expand Up @@ -3048,6 +3049,7 @@ paths:
- WorkflowService
description: |-
Deprecated. Use `DescribeTaskQueue`.
Will be removed in server version v1.32.0.

Fetches task reachability to determine whether a worker may be retired.
The request may specify task queues to query for or let the server fetch all task queues mapped to the given
Expand Down Expand Up @@ -7207,6 +7209,7 @@ paths:
- WorkflowService
description: |-
Deprecated. Use `GetWorkerVersioningRules`.
Will be removed in server version v1.32.0.
Fetches the worker build id versioning sets for a task queue.
operationId: GetWorkerBuildIdCompatibility
parameters:
Expand Down Expand Up @@ -7248,7 +7251,7 @@ paths:
- WorkflowService
description: |-
Fetches the Build ID assignment and redirect rules for a Task Queue.
WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
Will be removed in server version v1.32.0.
operationId: GetWorkerVersioningRules
parameters:
- name: namespace
Expand Down Expand Up @@ -7993,6 +7996,7 @@ paths:
- WorkflowService
description: |-
Deprecated. Use `DescribeTaskQueue`.
Will be removed in server version v1.32.0.

Fetches task reachability to determine whether a worker may be retired.
The request may specify task queues to query for or let the server fetch all task queues mapped to the given
Expand Down Expand Up @@ -11524,6 +11528,14 @@ components:
description: |-
Contains the historical state of failover_versions for the cluster, truncated to contain only the last N
states to ensure that the list does not grow unbounded.
pollerGroupInfos:
type: array
items:
$ref: '#/components/schemas/PollerGroupInfo'
description: |-
The initial info that client should use for poller group assignment. This information is
updated through poll response. Client is supposed to use the info received in the latest
poll response.
DescribeNexusOperationExecutionResponse:
type: object
properties:
Expand Down
11 changes: 8 additions & 3 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 @@ -102,6 +102,10 @@ message DescribeNamespaceResponse {
// Contains the historical state of failover_versions for the cluster, truncated to contain only the last N
// states to ensure that the list does not grow unbounded.
repeated temporal.api.replication.v1.FailoverStatus failover_history = 6;
// The initial info that client should use for poller group assignment. This information is
// updated through poll response. Client is supposed to use the info received in the latest
// poll response.
repeated temporal.api.taskqueue.v1.PollerGroupInfo poller_group_infos = 7;
}

message UpdateNamespaceRequest {
Expand Down Expand Up @@ -269,7 +273,7 @@ message PollWorkflowTaskQueueRequest {
temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
// Unless this is the first poll, the client must pass one of the poller group IDs received in
// `poller_group_infos` of the last the PollWorkflowTaskQueueResponse according to the
// instructions. If not set, the poll is routed randomly which can cause it being blocked
// instructions. If not set, the poll is routed randomly which can cause it to be blocked
// without receiving a task while the queue actually has tasks in another server location.
string poller_group_id = 10;
// The identity of the worker/client who is polling this task queue
Expand Down Expand Up @@ -482,7 +486,7 @@ message PollActivityTaskQueueRequest {
temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
// Unless this is the first poll, the client must pass one of the poller group IDs received in
// `poller_group_infos` of the last the PollActivityTaskQueueResponse according to the
// instructions. If not set, the poll is routed randomly which can cause it being blocked
// instructions. If not set, the poll is routed randomly which can cause it to be blocked
// without receiving a task while the queue actually has tasks in another server location.
string poller_group_id = 10;
// The identity of the worker/client
Expand Down Expand Up @@ -1950,7 +1954,7 @@ message PollNexusTaskQueueRequest {
temporal.api.taskqueue.v1.TaskQueue task_queue = 3;
// Unless this is the first poll, the client must pass one of the poller group IDs received in
// `poller_group_infos` of the last the PollNexusTaskQueueResponse according to the
// instructions. If not set, the poll is routed randomly which can cause it being blocked
// instructions. If not set, the poll is routed randomly which can cause it to be blocked
// without receiving a task while the queue actually has tasks in another server location.
string poller_group_id = 9;
// The identity of the client who initiated this request.
Expand Down Expand Up @@ -2903,6 +2907,7 @@ message TriggerWorkflowRuleResponse {
// True is the rule was applied, based on the rule conditions (predicate/visibility_query).
bool applied = 1;
}

message RecordWorkerHeartbeatRequest {
// Namespace this worker belongs to.
string namespace = 1;
Expand Down
7 changes: 5 additions & 2 deletions temporal/api/workflowservice/v1/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ service WorkflowService {
}

// Deprecated. Use `UpdateWorkerVersioningRules`.
// Will be removed in server version v1.32.0.
//
// Allows users to specify sets of worker build id versions on a per task queue basis. Versions
// are ordered, and may be either compatible with some extant version, or a new incompatible
Expand All @@ -879,6 +880,7 @@ service WorkflowService {
rpc UpdateWorkerBuildIdCompatibility (UpdateWorkerBuildIdCompatibilityRequest) returns (UpdateWorkerBuildIdCompatibilityResponse) {}

// Deprecated. Use `GetWorkerVersioningRules`.
// Will be removed in server version v1.32.0.
// Fetches the worker build id versioning sets for a task queue.
rpc GetWorkerBuildIdCompatibility (GetWorkerBuildIdCompatibilityRequest) returns (GetWorkerBuildIdCompatibilityResponse) {
option (google.api.http) = {
Expand Down Expand Up @@ -910,13 +912,13 @@ service WorkflowService {
// the target Build ID of a redirect rule is able to process event histories made by the source
// Build ID by using [Patching](https://docs.temporal.io/workflows#patching) or other means.
//
// WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
// Will be removed in server version v1.32.0.
// (-- api-linter: core::0127::http-annotation=disabled
// aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
rpc UpdateWorkerVersioningRules (UpdateWorkerVersioningRulesRequest) returns (UpdateWorkerVersioningRulesResponse) {}

// Fetches the Build ID assignment and redirect rules for a Task Queue.
// WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
// Will be removed in server version v1.32.0.
rpc GetWorkerVersioningRules (GetWorkerVersioningRulesRequest) returns (GetWorkerVersioningRulesResponse) {
option (google.api.http) = {
get: "/namespaces/{namespace}/task-queues/{task_queue}/worker-versioning-rules"
Expand All @@ -927,6 +929,7 @@ service WorkflowService {
}

// Deprecated. Use `DescribeTaskQueue`.
// Will be removed in server version v1.32.0.
//
// Fetches task reachability to determine whether a worker may be retired.
// The request may specify task queues to query for or let the server fetch all task queues mapped to the given
Expand Down
Loading