Class Step

A Step is a sub-component of a workflow. Each Step performs an action.

Hierarchy

  • Step

Constructors

constructor

Properties

actionId additionalProperties? completionGate? connectionLabel? display? errorHandlers? name outboundEdges? parameters? readinessGate?

Constructors

constructor

Properties

actionId

actionId: string

The unique identifier of an action.

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional completionGate

completionGate?: CompletionGate

Used to create conditions before running subsequent actions.

Optional connectionLabel

connectionLabel?: string

The unique identifier of a connection defined in the spec.

Optional display

display?: StepDisplay

The position of a step on the workflow canvas. Omit display from every step to use automatic layout, or provide it for every step to preserve a manual layout.

Optional errorHandlers

errorHandlers?: ErrorHandler[]

The Step errorHandlers.

name

name: string

Name of the step.

Optional outboundEdges

outboundEdges?: OutboundEdge[]

A list of subsequent actions to run. This list is empty for a terminal step.

Optional parameters

parameters?: Parameter[]

A list of inputs for an action.

Optional readinessGate

readinessGate?: ReadinessGate

Used to merge multiple branches into a single branch.

Settings

Member Visibility

Theme

Generated using TypeDoc