FailActivity interface
このアクティビティは、独自のスコープ内で失敗し、カスタム エラー メッセージとエラー コードを出力します。 エラー メッセージとコードは、文字列リテラルとして、または実行時に文字列に評価できる式として提供できます。 アクティビティ スコープは、パイプライン全体または制御アクティビティ (foreach、switch、until など) (失敗アクティビティが含まれている場合) にすることができます。
- Extends
プロパティ
| error |
Fail アクティビティのエラーの種類を分類するエラー コード。 実行時に空または空白以外の文字列に評価される動的コンテンツを指定できます。 型: string (または resultType 文字列を含む式)。 |
| message | Fail アクティビティに表示されたエラー メッセージ。 実行時に空または空白以外の文字列に評価される動的コンテンツを指定できます。 型: string (または resultType 文字列を含む式)。 |
| type | ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。 |
継承されたプロパティ
| depends |
アクティビティは条件によって異なります。 |
| description | アクティビティの説明。 |
| name | アクティビティ名。 |
| on |
状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。 |
| state | アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。 |
| user |
アクティビティ ユーザーのプロパティ。 |
プロパティの詳細
errorCode
Fail アクティビティのエラーの種類を分類するエラー コード。 実行時に空または空白以外の文字列に評価される動的コンテンツを指定できます。 型: string (または resultType 文字列を含む式)。
errorCode: anyプロパティ値
any
message
Fail アクティビティに表示されたエラー メッセージ。 実行時に空または空白以外の文字列に評価される動的コンテンツを指定できます。 型: string (または resultType 文字列を含む式)。
message: anyプロパティ値
any
type
ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。
type: "Fail"プロパティ値
"Fail"
継承されたプロパティの詳細
dependsOn
アクティビティは条件によって異なります。
dependsOn?: ActivityDependency[]プロパティ値
description
name
onInactiveMarkAs
状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。
onInactiveMarkAs?: stringプロパティ値
string
state
アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。
state?: stringプロパティ値
string
userProperties
アクティビティ ユーザーのプロパティ。
userProperties?: UserProperty[]