Skip to content

Commit 8c57e7b

Browse files
authored
Update backlog_count_hint docstring (#413)
1 parent 74f9631 commit 8c57e7b

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

openapi/openapiv2.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6569,7 +6569,7 @@
65696569
"backlogCountHint": {
65706570
"type": "string",
65716571
"format": "int64",
6572-
"description": "A hint that there are more tasks already present in this task queue. Can be used to\nprioritize draining a sticky queue before polling from a normal queue."
6572+
"description": "A hint that there are more tasks already present in this task queue \npartition. Can be used to prioritize draining a sticky queue.\n\nSpecifically, the returned number is the number of tasks remaining in\nthe in-memory buffer for this partition, which is currently capped at\n1000. Because sticky queues only have one partition, this number is \nmore useful when draining them. Normal queues, typically having more than one \npartition, will return a number representing only some portion of the \noverall backlog. Subsequent RPCs may not hit the same partition as \nthis call."
65736573
},
65746574
"history": {
65756575
"$ref": "#/definitions/v1History",

openapi/openapiv3.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -4474,9 +4474,7 @@ components:
44744474
format: int32
44754475
backlogCountHint:
44764476
type: string
4477-
description: |-
4478-
A hint that there are more tasks already present in this task queue. Can be used to
4479-
prioritize draining a sticky queue before polling from a normal queue.
4477+
description: "A hint that there are more tasks already present in this task queue \n partition. Can be used to prioritize draining a sticky queue.\n\n Specifically, the returned number is the number of tasks remaining in\n the in-memory buffer for this partition, which is currently capped at\n 1000. Because sticky queues only have one partition, this number is \n more useful when draining them. Normal queues, typically having more than one \n partition, will return a number representing only some portion of the \n overall backlog. Subsequent RPCs may not hit the same partition as \n this call."
44804478
history:
44814479
allOf:
44824480
- $ref: '#/components/schemas/History'

temporal/api/workflowservice/v1/request_response.proto

+10-2
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,16 @@ message PollWorkflowTaskQueueResponse {
278278
int64 started_event_id = 5;
279279
// Starting at 1, the number of attempts to complete this task by any worker.
280280
int32 attempt = 6;
281-
// A hint that there are more tasks already present in this task queue. Can be used to
282-
// prioritize draining a sticky queue before polling from a normal queue.
281+
// A hint that there are more tasks already present in this task queue
282+
// partition. Can be used to prioritize draining a sticky queue.
283+
//
284+
// Specifically, the returned number is the number of tasks remaining in
285+
// the in-memory buffer for this partition, which is currently capped at
286+
// 1000. Because sticky queues only have one partition, this number is
287+
// more useful when draining them. Normal queues, typically having more than one
288+
// partition, will return a number representing only some portion of the
289+
// overall backlog. Subsequent RPCs may not hit the same partition as
290+
// this call.
283291
int64 backlog_count_hint = 7;
284292
// The history for this workflow, which will either be complete or partial. Partial histories
285293
// are sent to workers who have signaled that they are using a sticky queue when completing

0 commit comments

Comments
 (0)