Package io.kestra.core.tasks.flows

Class Flow

java.lang.Object

io.kestra.core.models.tasks.Task

io.kestra.core.tasks.flows.Flow

All Implemented Interfaces:

ExecutableTask<Flow.Output>

@Plugin(examples=@Example(title="Run a subflow with custom inputs",code={"namespace: dev","flowId: subflow","inputs:","  user: \"Rick Astley\"","  favorite_song: \"Never Gonna Give You Up\"","wait: true","transmitFailed: true"}))
public class Flow
extends Task
implements ExecutableTask<Flow.Output>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Flow.Output

Nested classes/interfaces inherited from interface io.kestra.core.models.tasks.ExecutableTask

ExecutableTask.SubflowId

Field Summary

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

disabled, id, retry, timeout, type

Constructor Summary

Constructors

Constructor	Description
Flow()

Method Summary

Modifier and Type	Method	Description
List<WorkerTaskExecution<?>>	createWorkerTaskExecutions(RunContext runContext, FlowExecutorInterface flowExecutorInterface, Flow currentFlow, Execution currentExecution, TaskRun currentTaskRun)	Creates a list of WorkerTaskExecution for this task definition.
Optional<WorkerTaskResult>	createWorkerTaskResult(RunContext runContext, TaskRun taskRun, Flow flow, Execution execution)	Creates a WorkerTaskResult for a given WorkerTaskExecution
ExecutableTask.SubflowId	subflowId()
boolean	waitForExecution()	Whether to wait for the execution(s) of the subflow before terminating this tasks

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

Flow

public Flow()

Method Details

createWorkerTaskExecutions

public List<WorkerTaskExecution<?>> createWorkerTaskExecutions(RunContext runContext,
 FlowExecutorInterface flowExecutorInterface,
 Flow currentFlow,
 Execution currentExecution,
 TaskRun currentTaskRun)
                                                        throws InternalException

Description copied from interface: ExecutableTask

Creates a list of WorkerTaskExecution for this task definition. Each WorkerTaskExecution will generate a subflow execution.

Specified by:

createWorkerTaskExecutions in interface ExecutableTask<Flow.Output>

Throws:

InternalException

createWorkerTaskResult

public Optional<WorkerTaskResult> createWorkerTaskResult(RunContext runContext,
 TaskRun taskRun,
 Flow flow,
 Execution execution)

Description copied from interface: ExecutableTask

Creates a WorkerTaskResult for a given WorkerTaskExecution

Specified by:

createWorkerTaskResult in interface ExecutableTask<Flow.Output>

waitForExecution

public boolean waitForExecution()

Description copied from interface: ExecutableTask

Whether to wait for the execution(s) of the subflow before terminating this tasks

Specified by:

waitForExecution in interface ExecutableTask<Flow.Output>

subflowId

public ExecutableTask.SubflowId subflowId()

Specified by:

subflowId in interface ExecutableTask<Flow.Output>

Returns:

the subflow identifier, used by the flow topology and related dependency code.