ControlActivity interface

Base class for all control activities like IfCondition, ForEach , Until.

Extends

Properties

type

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

dependsOn

Activity depends on condition.

description

Activity description.

name

Activity name.

onInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

userProperties

Activity user properties.

Property Details

type

Polymorphic discriminator, which specifies the different types this object can be

type: "Container" | "ExecutePipeline" | "IfCondition" | "Switch" | "ForEach" | "Wait" | "Fail" | "Until" | "Validation" | "Filter" | "SetVariable" | "AppendVariable" | "WebHook"

Property Value

"Container" | "ExecutePipeline" | "IfCondition" | "Switch" | "ForEach" | "Wait" | "Fail" | "Until" | "Validation" | "Filter" | "SetVariable" | "AppendVariable" | "WebHook"

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

Inherited From Activity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From Activity.description

name

Activity name.

name: string

Property Value

string

Inherited From Activity.name

onInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

onInactiveMarkAs?: string

Property Value

string

Inherited From Activity.onInactiveMarkAs

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From Activity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

Inherited From Activity.userProperties