Skip to content

Commit 5b6d2a5

Browse files
authored
add activity_paused flag to ByID heartbeat response (#517)
<!-- Describe what has changed in this PR --> **What changed?** Add "activity_paused" flag to RecordActivityTaskHeartbeatByIdResponse. <!-- Tell your future self why have you made these changes --> **Why?** 1. It is needed to let long-running activity know that activity was paused on the server. 2. Because it is missing in RecordActivityTaskHeartbeatByIdResponse but present in RecordActivityTaskHeartbeatResponse <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** No.
1 parent 2a5b395 commit 5b6d2a5

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

Diff for: openapi/openapiv2.json

+4
Original file line numberDiff line numberDiff line change
@@ -10537,6 +10537,10 @@
1053710537
"cancelRequested": {
1053810538
"type": "boolean",
1053910539
"description": "Will be set to true if the activity has been asked to cancel itself. The SDK should then\nnotify the activity of cancellation if it is still running."
10540+
},
10541+
"activityPaused": {
10542+
"type": "boolean",
10543+
"description": "Will be set to true if the activity is paused."
1054010544
}
1054110545
}
1054210546
},

Diff for: openapi/openapiv3.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -7906,6 +7906,9 @@ components:
79067906
description: |-
79077907
Will be set to true if the activity has been asked to cancel itself. The SDK should then
79087908
notify the activity of cancellation if it is still running.
7909+
activityPaused:
7910+
type: boolean
7911+
description: Will be set to true if the activity is paused.
79097912
RecordActivityTaskHeartbeatRequest:
79107913
type: object
79117914
properties:

Diff for: temporal/api/workflowservice/v1/request_response.proto

+3
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,9 @@ message RecordActivityTaskHeartbeatByIdResponse {
518518
// Will be set to true if the activity has been asked to cancel itself. The SDK should then
519519
// notify the activity of cancellation if it is still running.
520520
bool cancel_requested = 1;
521+
522+
// Will be set to true if the activity is paused.
523+
bool activity_paused = 2;
521524
}
522525

523526
message RespondActivityTaskCompletedRequest {

0 commit comments

Comments
 (0)