pulumi-azure-native-kotlin/com.pulumi.azurenative.datafactory.kotlin.inputs/FailActivityArgs

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 onInactiveMarkAs: Output<Either<String, ActivityOnInactiveMarkAs>>? = null, val state: Output<Either<String, ActivityState>>? = null, 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>, onInactiveMarkAs: Output<Either<String, ActivityOnInactiveMarkAs>>? = null, state: Output<Either<String, ActivityState>>? = null, 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 onInactiveMarkAs: Output<Either<String, ActivityOnInactiveMarkAs>>? = null

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.

Link copied to clipboard
val state: Output<Either<String, ActivityState>>? = null

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

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