Skip to main content

Interface: StartNexusOperationOptions

workflow.StartNexusOperationOptions

Options for starting a Nexus Operation.

Nexus support in Temporal SDK is experimental.

Properties​

cancellationType​

• Optional Readonly cancellationType: NexusOperationCancellationType

Determines:

  • whether cancellation requests should be propagated from the Workflow to the Nexus Operation
  • whether and when should the Operation's cancellation be reported back to the Workflow (i.e. at which moment should the operation's result promise fail with a NexusOperationFailure, with cause set to a CancelledFailure).

Note that this setting only applies to cancellation originating from an external request for the Workflow itself, or from internal cancellation of the CancellationScope in which the Operation call was made.

Default

WAIT_CANCELLATION_COMPLETED

scheduleToCloseTimeout​

• Optional Readonly scheduleToCloseTimeout: Duration

The end to end timeout for the Nexus Operation.

Optional: defaults to the maximum allowed by the Temporal server.

scheduleToStartTimeout​

• Optional Readonly scheduleToStartTimeout: Duration

How long the operation may wait before it begins executing. If the operation has not started within this window, a timeout error with type SCHEDULE_TO_START is raised.

Optional: defaults to no timeout.

startToCloseTimeout​

• Optional Readonly startToCloseTimeout: Duration

How long an async operation may take to complete after it has started. If the operation does not complete within this window, a timeout error with type START_TO_CLOSE is raised.

Optional: defaults to no timeout.

summary​

• Optional Readonly summary: string

A fixed, single-line summary for this Nexus Operation that may appear in the UI/CLI. This can be in single-line Temporal markdown format.

User metadata is a new API and susceptible to change.