Skip to content

💥 Update documention of current_retry_interval and next_attempt_schedule_time #840

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
dandavison wants to merge 2 commits into
base: main
Choose a base branch
from
+38 −32
Open

💥 Update documention of current_retry_interval and next_attempt_schedule_time #840

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
1e164c8
Update docs for current_retry_interval and next_attempt_schedule_time
dandavison Jul 23, 2026
26ad7c3
autogen
dandavison Jul 24, 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
8 changes: 4 additions & 4 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13445,7 +13445,7 @@
},
"currentRetryInterval": {
"type": "string",
"description": "Time from the last attempt failure to the next activity retry.\nIf the activity is currently running, this represents the next retry interval in case the attempt fails.\nIf activity is currently backing off between attempt, this represents the current retry interval.\nIf there is no next retry allowed, this field will be null.\nThis interval is typically calculated from the specified retry policy, but may be modified if an activity fails\nwith a retryable application failure specifying a retry delay."
"description": "The retry interval for a currently pending retry: the amount of time between the last attempt\nfailure and when the next attempt will become available to worker poll requests. Set only\nduring retry backoff, i.e. when an activity is currently waiting for a retry, and the next\nactivity task has not yet become available to worker poll requests. Null at all other times,\nincluding when paused and during start delay. This is calculated from the active retry policy,\nbut can be overridden by an activity attempt that fails with a retryable application failure\nspecifying a next_retry_delay."
},
"lastAttemptCompleteTime": {
"type": "string",
Expand All @@ -13455,7 +13455,7 @@
"nextAttemptScheduleTime": {
"type": "string",
"format": "date-time",
"description": "The time when the next activity attempt will be scheduled.\nIf activity is currently scheduled or started, this field will be null."
"description": "The time at which the next activity attempt will become available to worker poll requests.\nSet only during start delay, and retry backoff. Null when paused."
},
"lastDeploymentVersion": {
"$ref": "#/definitions/v1WorkerDeploymentVersion",
Expand Down Expand Up @@ -17722,7 +17722,7 @@
},
"currentRetryInterval": {
"type": "string",
"description": "The time activity will wait until the next retry.\nIf activity is currently running it will be next retry interval if activity failed.\nIf activity is currently waiting it will be current retry interval.\nIf there will be no retry it will be null."
"description": "The retry interval for a currently pending retry: the amount of time between the last attempt\nfailure and when the next attempt will become available to worker poll requests. Set only\nduring retry backoff, i.e. when an activity is currently waiting for a retry, and the next\nactivity task has not yet become available to worker poll requests. Null at all other times\nincluding when paused. This is calculated from the active retry policy, but can be overridden by\nan activity attempt that fails with a retryable application failure specifying a next_retry_delay."
},
"lastAttemptCompleteTime": {
"type": "string",
Expand All @@ -17732,7 +17732,7 @@
"nextAttemptScheduleTime": {
"type": "string",
"format": "date-time",
"description": "Next time when activity will be scheduled.\nIf activity is currently scheduled or started it will be null."
"description": "The time at which the next activity attempt will become available to worker poll requests.\nSet only during retry backoff. Null when paused."
},
"paused": {
"type": "boolean",
Expand Down
31 changes: 17 additions & 14 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9790,21 +9790,22 @@ components:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
description: |-
Time from the last attempt failure to the next activity retry.
If the activity is currently running, this represents the next retry interval in case the attempt fails.
If activity is currently backing off between attempt, this represents the current retry interval.
If there is no next retry allowed, this field will be null.
This interval is typically calculated from the specified retry policy, but may be modified if an activity fails
with a retryable application failure specifying a retry delay.
The retry interval for a currently pending retry: the amount of time between the last attempt
failure and when the next attempt will become available to worker poll requests. Set only
during retry backoff, i.e. when an activity is currently waiting for a retry, and the next
activity task has not yet become available to worker poll requests. Null at all other times,
including when paused and during start delay. This is calculated from the active retry policy,
but can be overridden by an activity attempt that fails with a retryable application failure
specifying a next_retry_delay.
lastAttemptCompleteTime:
type: string
description: The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
format: date-time
nextAttemptScheduleTime:
type: string
description: |-
The time when the next activity attempt will be scheduled.
If activity is currently scheduled or started, this field will be null.
The time at which the next activity attempt will become available to worker poll requests.
Set only during start delay, and retry backoff. Null when paused.
format: date-time
lastDeploymentVersion:
allOf:
Expand Down Expand Up @@ -14156,19 +14157,21 @@ components:
pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
type: string
description: |-
The time activity will wait until the next retry.
If activity is currently running it will be next retry interval if activity failed.
If activity is currently waiting it will be current retry interval.
If there will be no retry it will be null.
The retry interval for a currently pending retry: the amount of time between the last attempt
failure and when the next attempt will become available to worker poll requests. Set only
during retry backoff, i.e. when an activity is currently waiting for a retry, and the next
activity task has not yet become available to worker poll requests. Null at all other times
including when paused. This is calculated from the active retry policy, but can be overridden by
an activity attempt that fails with a retryable application failure specifying a next_retry_delay.
lastAttemptCompleteTime:
type: string
description: The time when the last activity attempt was completed. If activity has not been completed yet then it will be null.
format: date-time
nextAttemptScheduleTime:
type: string
description: |-
Next time when activity will be scheduled.
If activity is currently scheduled or started it will be null.
The time at which the next activity attempt will become available to worker poll requests.
Set only during retry backoff. Null when paused.
format: date-time
paused:
type: boolean
Expand Down
17 changes: 9 additions & 8 deletions temporal/api/activity/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,19 +135,20 @@ message ActivityExecutionInfo {
temporal.api.failure.v1.Failure last_failure = 20;
string last_worker_identity = 21;

// Time from the last attempt failure to the next activity retry.
// If the activity is currently running, this represents the next retry interval in case the attempt fails.
// If activity is currently backing off between attempt, this represents the current retry interval.
// If there is no next retry allowed, this field will be null.
// This interval is typically calculated from the specified retry policy, but may be modified if an activity fails
// with a retryable application failure specifying a retry delay.
// The retry interval for a currently pending retry: the amount of time between the last attempt
// failure and when the next attempt will become available to worker poll requests. Set only
// during retry backoff, i.e. when an activity is currently waiting for a retry, and the next
// activity task has not yet become available to worker poll requests. Null at all other times,
// including when paused and during start delay. This is calculated from the active retry policy,

@fretz12 fretz12 Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe when paused, the server still returns the stale future next_attempt_schedule_time and current_retry_interval. So I think we should clear those during pause for server

@dandavison dandavison Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks updated the server PR to do that.

// but can be overridden by an activity attempt that fails with a retryable application failure
// specifying a next_retry_delay.
google.protobuf.Duration current_retry_interval = 22;

// The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
google.protobuf.Timestamp last_attempt_complete_time = 23;

// The time when the next activity attempt will be scheduled.
// If activity is currently scheduled or started, this field will be null.
// The time at which the next activity attempt will become available to worker poll requests.
// Set only during start delay, and retry backoff. Null when paused.
google.protobuf.Timestamp next_attempt_schedule_time = 24;

// The Worker Deployment Version this activity was dispatched to most recently.
Expand Down
14 changes: 8 additions & 6 deletions temporal/api/workflow/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,17 +307,19 @@ message PendingActivityInfo {
// This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
temporal.api.common.v1.WorkerVersionStamp last_worker_version_stamp = 15 [deprecated = true];

// The time activity will wait until the next retry.
// If activity is currently running it will be next retry interval if activity failed.
// If activity is currently waiting it will be current retry interval.
// If there will be no retry it will be null.
// The retry interval for a currently pending retry: the amount of time between the last attempt
// failure and when the next attempt will become available to worker poll requests. Set only
// during retry backoff, i.e. when an activity is currently waiting for a retry, and the next
// activity task has not yet become available to worker poll requests. Null at all other times
// including when paused. This is calculated from the active retry policy, but can be overridden by
// an activity attempt that fails with a retryable application failure specifying a next_retry_delay.
google.protobuf.Duration current_retry_interval = 16;

// The time when the last activity attempt was completed. If activity has not been completed yet then it will be null.
google.protobuf.Timestamp last_attempt_complete_time = 17;

// Next time when activity will be scheduled.
// If activity is currently scheduled or started it will be null.
// The time at which the next activity attempt will become available to worker poll requests.
// Set only during retry backoff. Null when paused.
google.protobuf.Timestamp next_attempt_schedule_time = 18;

// Indicates if activity is paused.
Expand Down
Loading