pulumi-azure-native-kotlin/com.pulumi.azurenative.datafactory.kotlin.outputs/FailActivityResponse

FailActivityResponse

data class FailActivityResponse(val dependsOn: List<ActivityDependencyResponse>? = null, val description: String? = null, val errorCode: Any, val message: Any, val name: String, val onInactiveMarkAs: String? = null, val state: String? = null, 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

constructor(dependsOn: List<ActivityDependencyResponse>? = null, description: String? = null, errorCode: Any, message: Any, name: String, onInactiveMarkAs: String? = null, state: String? = null, type: String, userProperties: List<UserPropertyResponse>? = null)

Types

Companion

object Companion

Properties

dependsOn

val dependsOn: List<ActivityDependencyResponse>? = null

Activity depends on condition.

description

val description: String? = null

Activity description.

errorCode

val 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

val 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

val name: String

Activity name.

onInactiveMarkAs

val onInactiveMarkAs: String? = 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.

state

val state: String? = null

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

type

val type: String

Type of activity. Expected value is 'Fail'.

userProperties

val userProperties: List<UserPropertyResponse>? = null

Activity user properties.