Package io.kestra.core.tasks.flows

Class Template

java.lang.Object

io.kestra.core.models.tasks.Task

io.kestra.core.tasks.flows.Template

All Implemented Interfaces:

FlowableTask<Template.Output>

Direct Known Subclasses:

Template.ExecutorTemplate

@Plugin(examples=@Example(full=true,code={"id: template","namespace: io.kestra.tests","","inputs:","  - name: with-string","    type: STRING","","tasks:","  - id: 1-return","    type: io.kestra.core.tasks.debugs.Return","    format: \"{{task.id}} > {{taskrun.startDate}}\"","  - id: 2-template","    type: io.kestra.core.tasks.flows.Template","    namespace: io.kestra.tests","    templateId: template","    args:","      my-forward: \"{{ inputs.with-string }}\"","  - id: 3-end","    type: io.kestra.core.tasks.debugs.Return","    format: \"{{task.id}} > {{taskrun.startDate}}\"\n"}))
@TemplateEnabled
public class Template
extends Task
implements FlowableTask<Template.Output>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Template.ContextHelper	Ugly hack to provide the ApplicationContext on {allChildTasks()} & {tasksTree(io.kestra.core.models.executions.Execution, io.kestra.core.models.executions.TaskRun, java.util.List<java.lang.String>)} We need to inject a way to fetch Template ...
static class	Template.ExecutorTemplate
static class	Template.MemoryTemplateExecutor
static class	Template.Output
static interface	Template.TemplateExecutorInterface

Field Summary

Fields

Modifier and Type	Field	Description
protected @Valid List<Task>	errors

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

disabled, id, retry, timeout, type

Constructor Summary

Constructors

Constructor	Description
Template()

Method Summary

Modifier and Type	Method	Description
List<Task>	allChildTasks()
List<ResolvedTask>	childTasks(RunContext runContext, TaskRun parentTaskRun)	Resolve child tasks of a flowable task.
protected Template	findTemplate(io.micronaut.context.ApplicationContext applicationContext)
static Flow	injectTemplate(Flow flow, Execution execution, org.apache.commons.lang3.function.TriFunction<String,String,String,Template> provider)
Template.Output	outputs(RunContext runContext, Execution execution, TaskRun parentTaskRun)
List<NextTaskRun>	resolveNexts(RunContext runContext, Execution execution, TaskRun parentTaskRun)	Resolve next tasks to run for an execution.
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

getErrors, resolveState

Field Details

errors

@Valid
@PluginProperty
protected @Valid List<Task> errors

Constructor Details

Template

public Template()

Method Details

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<Template.Output>

Throws:

IllegalVariableEvaluationException

allChildTasks

public List<Task> allChildTasks()

Specified by:

allChildTasks in interface FlowableTask<Template.Output>

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<Template.Output>

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<Template.Output>

Throws:

IllegalVariableEvaluationException

outputs

public Template.Output outputs(RunContext runContext,
 Execution execution,
 TaskRun parentTaskRun)
                        throws IllegalVariableEvaluationException

Specified by:

outputs in interface FlowableTask<Template.Output>

Throws:

IllegalVariableEvaluationException

findTemplate

protected Template findTemplate(io.micronaut.context.ApplicationContext applicationContext)
                         throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

injectTemplate

public static Flow injectTemplate(Flow flow,
 Execution execution,
 org.apache.commons.lang3.function.TriFunction<String,String,String,Template> provider)
                           throws InternalException

Throws:

InternalException