Skip to main content

Interface: NexusUpdateWorkflowOptions

nexus.NexusUpdateWorkflowOptions

Options for UpdatableWorkflowHandle.update. The target Workflow (workflow and run IDs) is carried by the handle, and the Update definition or name is passed as the method's first argument, so only the Update ID is supplied here.

The Update's arguments are intersected onto this type by each update overload, so that args is required for an Update that takes arguments and rejected for one that does not.

Nexus support in Temporal SDK is experimental.

Properties​

updateId​

• Optional Readonly updateId: string

The Update ID, a unique-per-Workflow-Execution identifier for this Update.

If unset, the Nexus request ID is used as the Update ID. This protects against a retried Nexus request (e.g. after a network failure) spawning a duplicate Update.