FailActivityArgs

data class FailActivityArgs(val dependsOn: Output<List<ActivityDependencyArgs>>? = null, val description: Output<String>? = null, val errorCode: Output<Any>, val message: Output<Any>, val name: Output<String>, val type: Output<String>, val userProperties: Output<List<UserPropertyArgs>>? = null) : ConvertibleToJava<FailActivityArgs>

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: Output<List<ActivityDependencyArgs>>? = null, description: Output<String>? = null, errorCode: Output<Any>, message: Output<Any>, name: Output<String>, type: Output<String>, userProperties: Output<List<UserPropertyArgs>>? = null)

Properties

Link copied to clipboard
val dependsOn: Output<List<ActivityDependencyArgs>>? = null

Activity depends on condition.

Link copied to clipboard
val description: Output<String>? = null

Activity description.

Link copied to clipboard
val errorCode: Output<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).

Link copied to clipboard
val message: Output<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).

Link copied to clipboard
val name: Output<String>

Activity name.

Link copied to clipboard
val type: Output<String>

Type of activity. Expected value is 'Fail'.

Link copied to clipboard
val userProperties: Output<List<UserPropertyArgs>>? = null

Activity user properties.

Functions

Link copied to clipboard
open override fun toJava(): FailActivityArgs