Package io.kestra.core.tasks.flows

Class If

java.lang.Object

io.kestra.core.models.tasks.Task

io.kestra.core.tasks.flows.If

All Implemented Interfaces:

FlowableTask<VoidOutput>

@Plugin(examples=@Example(full=true,code={"id: if","namespace: io.kestra.tests","","inputs:","  - name: string","    type: STRING","    required: true","","tasks:","  - id: if","    type: io.kestra.core.tasks.flows.If","    condition: \"{{inputs.string == \'Condition\'}}\"","    then:","      - id: when_true","        type: io.kestra.core.tasks.log.Log","        message: \'Condition was true\'","    else:","      - id: when_false","        type: io.kestra.core.tasks.log.Log","        message: \'Condition was false\'"}))
public class If
extends Task
implements FlowableTask<VoidOutput>

Field Summary

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

disabled, id, retry, timeout, type

Constructor Summary

Constructors

Constructor	Description
If()

Method Summary

Modifier and Type	Method	Description
List<Task>	allChildTasks()
List<ResolvedTask>	childTasks(RunContext runContext, TaskRun parentTaskRun)	Resolve child tasks of a flowable task.
List<Task>	getErrors()
List<NextTaskRun>	resolveNexts(RunContext runContext, Execution execution, TaskRun parentTaskRun)	Resolve next tasks to run for an execution.
Optional<State.Type>	resolveState(RunContext runContext, Execution execution, TaskRun parentTaskRun)	Resolve the state of a flowable task.
GraphCluster	tasksTree(Execution execution, TaskRun taskRun, List<String> parentValues)	Create the topology representation of a flowable 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

Methods inherited from interface io.kestra.core.models.tasks.FlowableTask

outputs

Constructor Details

If

public If()

Method Details

getErrors

public List<Task> getErrors()

Specified by:

getErrors in interface FlowableTask<VoidOutput>

tasksTree

public GraphCluster tasksTree(Execution execution,
 TaskRun taskRun,
 List<String> parentValues)
                       throws IllegalVariableEvaluationException

Description copied from interface: FlowableTask

Create the topology representation of a flowable task.

A flowable task always contains subtask to it returns a cluster that displays the subtasks.

Specified by:

tasksTree in interface FlowableTask<VoidOutput>

Throws:

IllegalVariableEvaluationException

allChildTasks

public List<Task> allChildTasks()

Specified by:

allChildTasks in interface FlowableTask<VoidOutput>

Returns:

all child tasks including errors

childTasks

public List<ResolvedTask> childTasks(RunContext runContext,
 TaskRun parentTaskRun)
                              throws IllegalVariableEvaluationException

Description copied from interface: FlowableTask

Resolve child tasks of a flowable task.

For a normal flowable, it should be the list of its tasks, for an iterative flowable (such as EachSequential, ForEachItem, ...), it should be the list of its tasks for all iterations.

Specified by:

childTasks in interface FlowableTask<VoidOutput>

Throws:

IllegalVariableEvaluationException

resolveNexts

public List<NextTaskRun> resolveNexts(RunContext runContext,
 Execution execution,
 TaskRun parentTaskRun)
                               throws IllegalVariableEvaluationException

Description copied from interface: FlowableTask

Resolve next tasks to run for an execution.

For a normal flowable, it should be the subsequent task, for a parallel flowable (such as Parallel, ForEachItem, ...), it should be a list of the next subsequent tasks of the size of the concurrency of the task.

Specified by:

resolveNexts in interface FlowableTask<VoidOutput>

Throws:

IllegalVariableEvaluationException

resolveState

public Optional<State.Type> resolveState(RunContext runContext,
 Execution execution,
 TaskRun parentTaskRun)
                                  throws IllegalVariableEvaluationException

Description copied from interface: FlowableTask

Resolve the state of a flowable task.

Specified by:

resolveState in interface FlowableTask<VoidOutput>

Throws:

IllegalVariableEvaluationException