Type Alias Task

type Task = {
    annotations?: string[];
    description?: string;
    enabled?: boolean;
    events?: Events;
    id?: string;
    keepActive?: boolean;
    key?: string;
    metadata?: TaskMetadata;
    name: string;
    resourceId?: string;
    specVersion: string;
    start?: Startdef;
    states?: Eventstate[];
    version?: string;
}
Index

Properties

annotations? description? enabled? events? id? keepActive? key? metadata? name resourceId? specVersion start? states? version?

Properties

annotations?: string[]

List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities

description?: string

Workflow description

enabled?: boolean

Indicates whether the task is enabled or not

events?: Events

Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced

id?: string

The choreographer's unique identifier

keepActive?: boolean

If 'true', workflow instances is not terminated when there are no active execution paths. Instance can be terminated via 'terminate end definition' or reaching defined 'workflowExecTimeout'

key?: string

Optional expression that will be used to generate a domain-specific workflow instance identifier

metadata?: TaskMetadata
name: string

The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier.

resourceId?: string

The resource ID of the task. The Task.resourceId value from user input is ignored and will be calculated automatically from Task.states.

specVersion: string

Serverless Workflow schema version

start?: Startdef
states?: Eventstate[]

State definitions

version?: string

Workflow version

Settings

Member Visibility

On This Page

Properties