FailActivity Class

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.

Constructor

FailActivity(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

Activity name. Required.
description
str

Activity description.
state
str or ActivityState

Activity state. This is an optional property and if not provided, the state will be Active by default. Known values are: "Active" and "Inactive".
on_inactive_mark_as
str or ActivityOnInactiveMarkAs

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. Known values are: "Succeeded", "Failed", and "Skipped".
depends_on
list[ActivityDependency]

Activity depends on condition.
user_properties
list[UserProperty]

Activity user properties.
type_properties
FailActivityTypeProperties

Fail activity properties. Required.
type
str

Type of activity. Required. Default value is "Fail".

Attributes

type

Type of activity. Required. Default value is "Fail".

type: Literal['Fail']

type_properties

Fail activity properties. Required.

type_properties: _models.FailActivityTypeProperties