Terminate
Force a job to terminate in Success or Error.
Json
Example
json
{
"name": "terminate",
"taskReferenceName": "terminate",
"description": "Force the job to terminate in success",
"type": "TERMINATE",
"inputParameters": {
"terminationStatus": "COMPLETED"
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
json
{
"name": "terminate",
"taskReferenceName": "terminate",
"description": "Force the job to terminate in error",
"type": "TERMINATE",
"inputParameters": {
"terminationStatus": "FAILED",
"outputParameters": {
"error_message": "${error_message.output.message}"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Definition
Property | Description |
---|---|
name | The name of the task, must be: terminate |
taskReferenceName | The unique name of the task in your job. |
description | The functional description of this task in your job. |
type | Set TERMINATE for this task. |
inputParameters | For the decision task you must define a key with the output of a previous task. The output must be an enum. Best practice: use the name of the output paramater for the property key. |
Inputs
Property | Description |
---|---|
terminationStatus | COMPLETED | FAILED . COMPLETED the job will end in success. FAILED the job will end in error. |
outputParameters | optional an object of outputs that you want to display to users. |
Outputs
This task does not have outputs.