FailActivityResponse

data class FailActivityResponse(val dependsOn: List<ActivityDependencyResponse>? = null, val description: String? = null, val errorCode: Any, val message: Any, val name: String, val type: String, val userProperties: List<UserPropertyResponse>? = null)

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.

Constructors

Link copied to clipboard
constructor(dependsOn: List<ActivityDependencyResponse>? = null, description: String? = null, errorCode: Any, message: Any, name: String, type: String, userProperties: List<UserPropertyResponse>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Activity depends on condition.

Link copied to clipboard
val description: String? = null

Activity description.

Link copied to clipboard

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).

Link copied to clipboard

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).

Link copied to clipboard

Activity name.

Link copied to clipboard

Type of activity. Expected value is 'Fail'.

Link copied to clipboard

Activity user properties.