Skip to content

Commit f224850

Browse files
authored
add time-skipping config in WorkflowExecutionStartedEventAttributes (#758)
**What changed?** add time-skipping config (optional field) in WorkflowExecutionStartedEventAttributes **Why?** there won't be a way to show it to users and support workflow rebuilt
1 parent 7df3c3e commit f224850

3 files changed

Lines changed: 22 additions & 0 deletions

File tree

openapi/openapiv2.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18628,6 +18628,10 @@
1862818628
"declinedTargetVersionUpgrade": {
1862918629
"$ref": "#/definitions/v1DeclinedTargetVersionUpgrade",
1863018630
"description": "During a previous run of this workflow, the server may have notified the SDK\nthat the Target Worker Deployment Version changed, but the SDK declined to\nupgrade (e.g., by continuing-as-new with PINNED behavior). This field records\nthe target version that was declined.\n\nThis is a wrapper message to distinguish \"never declined\" (nil wrapper) from\n\"declined an unversioned target\" (non-nil wrapper with nil deployment_version).\n\nUsed internally by the server during continue-as-new and retry.\nShould not be read or interpreted by SDKs."
18631+
},
18632+
"timeSkippingConfig": {
18633+
"$ref": "#/definitions/v1TimeSkippingConfig",
18634+
"description": "Initial time-skipping configuration for this workflow execution, recorded at start time.\nThis may have been set explicitly via the start workflow request, or propagated from a\nparent/previous execution.\n\nThe configuration may be updated after start via UpdateWorkflowExecutionOptions, which\nwill be reflected in the WorkflowExecutionOptionsUpdatedEvent."
1863118635
}
1863218636
},
1863318637
"title": "Always the first event in workflow history"

openapi/openapiv3.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17358,6 +17358,16 @@ components:
1735817358

1735917359
Used internally by the server during continue-as-new and retry.
1736017360
Should not be read or interpreted by SDKs.
17361+
timeSkippingConfig:
17362+
allOf:
17363+
- $ref: '#/components/schemas/TimeSkippingConfig'
17364+
description: |-
17365+
Initial time-skipping configuration for this workflow execution, recorded at start time.
17366+
This may have been set explicitly via the start workflow request, or propagated from a
17367+
parent/previous execution.
17368+
17369+
The configuration may be updated after start via UpdateWorkflowExecutionOptions, which
17370+
will be reflected in the WorkflowExecutionOptionsUpdatedEvent.
1736117371
description: Always the first event in workflow history
1736217372
WorkflowExecutionTerminatedEventAttributes:
1736317373
type: object

temporal/api/history/v1/message.proto

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,14 @@ message WorkflowExecutionStartedEventAttributes {
196196
// Used internally by the server during continue-as-new and retry.
197197
// Should not be read or interpreted by SDKs.
198198
DeclinedTargetVersionUpgrade declined_target_version_upgrade = 40;
199+
200+
// Initial time-skipping configuration for this workflow execution, recorded at start time.
201+
// This may have been set explicitly via the start workflow request, or propagated from a
202+
// parent/previous execution.
203+
//
204+
// The configuration may be updated after start via UpdateWorkflowExecutionOptions, which
205+
// will be reflected in the WorkflowExecutionOptionsUpdatedEvent.
206+
temporal.api.workflow.v1.TimeSkippingConfig time_skipping_config = 41;
199207
}
200208

201209
// Wrapper for a target deployment version that the SDK declined to upgrade to.

0 commit comments

Comments
 (0)