Package io.kestra.core.tasks.executions

Class Fail

java.lang.Object

io.kestra.core.models.tasks.Task

io.kestra.core.tasks.executions.Fail

All Implemented Interfaces:

RunnableTask<VoidOutput>

@Example(title="Fail on a switch branch",full=true,code="id: fail-on-switch\nnamespace: io.kestra.tests\n\ninputs:\n  - name: param\n    type: STRING\n    required: true\n\ntasks:\n  - id: switch\n    type: io.kestra.core.tasks.flows.Switch\n    value: \"{{inputs.param}}\"\n    cases:\n      case1:\n        - id: case1\n          type: io.kestra.core.tasks.log.Log\n          message: Case 1\n      case2:\n        - id: case2\n          type: io.kestra.core.tasks.log.Log\n          message: Case 2\n      notexist:\n        - id: fail\n          type: io.kestra.core.tasks.executions.Fail\n      default:\n        - id: default\n          type: io.kestra.core.tasks.log.Log\n          message: default") @Example(title="Fail on a condition",full=true,code="id: fail-on-condition\nnamespace: io.kestra.tests\n\ninputs:\n  - name: param\n    type: STRING\n    required: true\n\ntasks:\n  - id: before\n    type: io.kestra.core.tasks.debugs.Echo\n    format: I\'m before the fail on condition \n  - id: fail\n    type: io.kestra.core.tasks.executions.Fail\n    condition: \'{{inputs.param == \"fail\"}}\'\n  - id: after\n    type: io.kestra.core.tasks.debugs.Echo\n    format: I\'m after the fail on condition ")
public class Fail
extends Task
implements RunnableTask<VoidOutput>

Field Summary

Fields inherited from class io.kestra.core.models.tasks.Task

disabled, id, retry, timeout, type

Constructor Summary

Constructors

Constructor	Description
Fail()

Method Summary

Modifier and Type	Method	Description
VoidOutput	run(RunContext runContext)	Thsis method is called inside the Worker to run (execute) the task.

Methods inherited from class io.kestra.core.models.tasks.Task

findById, findById, isFlowable, isSendToWorkerTask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Fail

public Fail()

Method Details

run

public VoidOutput run(RunContext runContext)
               throws Exception

Description copied from interface: RunnableTask

Thsis method is called inside the Worker to run (execute) the task.

Specified by:

run in interface RunnableTask<VoidOutput>

Throws:

Exception