Interface: ContinueAsNewOptions
Options for continuing a Workflow as new
Properties
backoffStartInterval?
optionalbackoffStartInterval?:Duration
Delay before the first Workflow Task of the continued run is scheduled
Format
eventGroups?
optionaleventGroups?:EventGroup[]
Experimental
Event Groups to attach to the continue-as-new command. They will be reflected on the corresponding workflow history events, and may be used by tooling (UI/CLI) to group related events together. See EventGroup and createEventGroup.
Note that event group markers are never propagated across workflow executions.
Event Groups is an experimental API and may change without notice.
initialVersioningBehavior?
optionalinitialVersioningBehavior?:InitialVersioningBehavior
Experimental
Defines the versioning behavior to be used by the first task of a new workflow run in a continue-as-new chain.
Versioning semantics with continue-as-new are experimental and may change in the future.
memo?
optionalmemo?:Record<string,unknown>
Non-searchable attributes to attach to next Workflow run
searchAttributes?
optionalsearchAttributes?:SearchAttributes
Searchable attributes to attach to next Workflow run
Deprecated
Use typedSearchAttributes instead.
taskQueue?
optionaltaskQueue?:string
Task queue to continue the Workflow in
typedSearchAttributes?
optionaltypedSearchAttributes?:SearchAttributePair[] |TypedSearchAttributes
Specifies additional indexed information to attach to the Workflow Execution. More info: https://docs.temporal.io/docs/typescript/search-attributes
Values are always converted using JsonPayloadConverter, even when a custom data converter is provided. Note that search attributes are not encoded, as such, do not include any sensitive information.
If both searchAttributes and typedSearchAttributes are provided, conflicting keys will be overwritten by typedSearchAttributes.
typeInfo?
optionaltypeInfo?:Pick<PayloadTypeInfo,"inputTypes">
Experimental
Input type information for the next Workflow run.
When continuing as new to the same Workflow type, its definition-supplied input type information is reused. Provide this option when continuing as new to a different string-named Workflow type. The next Workflow must preserve the current Workflow's output contract because clients retain the original handle's output type information across the run chain.
versioningIntent?
optionalversioningIntent?:VersioningIntent
When using the Worker Versioning feature, specifies whether this Workflow should Continue-as-New onto a worker with a compatible Build Id or not. See VersioningIntent.
Default
'COMPATIBLE'
Deprecated
Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
workflowRunTimeout?
optionalworkflowRunTimeout?:Duration
Timeout for the entire Workflow run
Format
workflowTaskTimeout?
optionalworkflowTaskTimeout?:Duration
Timeout for a single Workflow task
Format
workflowType?
optionalworkflowType?:string
A string representing the Workflow type name, e.g. the filename in the Node.js SDK or class name in Java