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 | Type | Required | Description |
|---|---|---|---|
| The name (or type) of the task | |||
| The unique name of the task in your job. It is used to reference this task in the workflow. | |||
| The functional description of this task in your job. | |||
The type of the task. It must be SUB_WORKFLOW. | |||
true: the job continues if there is an error on this task. false: the job fails. | |||
| Input parameters of the task. See below |
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.