Package version:

Interface FailActivity

This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it.

Hierarchy

Properties

dependsOn?: ActivityDependency[]

Activity depends on condition.

description?: string

Activity description.

errorCode: any

The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).

message: any

The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string).

name: string

Activity name.

type: "Fail"

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

userProperties?: UserProperty[]

Activity user properties.

Generated using TypeDoc