Skip to main content

Interface: IWorkflowDefinition

sdk.v1.IWorkflowDefinition

Properties of a WorkflowDefinition.

Implemented by​

Properties​

description​

• Optional description: null | string

An optional workflow description provided by the application. By convention, external tools may interpret its first part, i.e., ending with a line break, as a summary of the description.

queryDefinitions​

• Optional queryDefinitions: null | IWorkflowInteractionDefinition[]

WorkflowDefinition queryDefinitions

signalDefinitions​

• Optional signalDefinitions: null | IWorkflowInteractionDefinition[]

WorkflowDefinition signalDefinitions

type​

• Optional type: null | string

A name scoped by the task queue that maps to this workflow definition. If missing, this workflow is a dynamic workflow.

updateDefinitions​

• Optional updateDefinitions: null | IWorkflowInteractionDefinition[]

WorkflowDefinition updateDefinitions