Package io.kestra.core.runners

Class RunContext

java.lang.Object

io.kestra.core.runners.RunContext

public class RunContext
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	temporaryDirectory

Constructor Summary

Constructors

Constructor	Description
RunContext(io.micronaut.context.ApplicationContext applicationContext, Flow flow, Execution execution)	Only used by Flow
RunContext(io.micronaut.context.ApplicationContext applicationContext, Flow flow, Task task, Execution execution, TaskRun taskRun)	Normal usage
RunContext(io.micronaut.context.ApplicationContext applicationContext, Flow flow, AbstractTrigger trigger)	Only used by AbstractTrigger, then scheduler must call forScheduler(TriggerContext, AbstractTrigger)
RunContext(io.micronaut.context.ApplicationContext applicationContext, Map<String,Object> variables)	Only used by Unit Test

Method Summary

Modifier and Type	Method	Description
void	cleanup()
Optional<Boolean>	deleteTaskCacheFile(String namespace, String flowId, String taskId, String value)
boolean	deleteTaskStateFile(String state, String name)
boolean	deleteTaskStateFile(String state, String name, Boolean isNamespace, Boolean useTaskRun)
void	dynamicWorkerResult(List<WorkerTaskResult> workerTaskResults)
List<WorkerTaskResult>	dynamicWorkerResults()
String	fileExtension(String fileName)	Get the file extension including the '.' to be used with the various methods that took a suffix.
RunContext	forScheduler(TriggerContext triggerContext, AbstractTrigger trigger)
RunContext	forWorker(io.micronaut.context.ApplicationContext applicationContext, WorkerTask workerTask)
RunContext	forWorker(io.micronaut.context.ApplicationContext applicationContext, WorkerTrigger workerTrigger)
RunContext	forWorkerDirectory(io.micronaut.context.ApplicationContext applicationContext, WorkerTask workerTask)
io.micronaut.context.ApplicationContext	getApplicationContext()
URI	getStorageOutputPrefix()
Optional<InputStream>	getTaskCacheFile(String namespace, String flowId, String taskId, String value)	Get from the internal storage the cache file corresponding to this task.
Optional<Long>	getTaskCacheFileLastModifiedTime(String namespace, String flowId, String taskId, String value)
InputStream	getTaskStateFile(String state, String name)
InputStream	getTaskStateFile(String state, String name, Boolean isNamespace, Boolean useTaskRun)
String	getTriggerExecutionId()
Map<String,Object>	getVariables()
protected void	initBean(io.micronaut.context.ApplicationContext applicationContext)
org.slf4j.Logger	logger()
<T> RunContext	metric(AbstractMetricEntry<T> metricEntry)
List<AbstractMetricEntry<?>>	metrics()
List<URI>	purgeStorageExecution()
URI	putTaskCacheFile(File file, String namespace, String flowId, String taskId, String value)	Put into the internal storage the cache file corresponding to this task.
URI	putTaskStateFile(byte[] content, String state, String name)
URI	putTaskStateFile(byte[] content, String state, String name, Boolean namespace, Boolean useTaskRun)
URI	putTaskStateFile(File file, String state, String name)
URI	putTaskStateFile(File file, String state, String name, Boolean isNamespace, Boolean useTaskRun)
URI	putTempFile(File file)	Put the temporary file on storage and delete it after.
URI	putTempFile(File file, String name)	Put the temporary file on storage and delete it after.
URI	putTempFile(File file, String executionId, AbstractTrigger trigger)	Put the temporary file on storage and delete it after.
String	render(String inline)
String	render(String inline, Map<String,Object> variables)
List<String>	render(List<String> inline)
List<String>	render(List<String> inline, Map<String,Object> variables)
Map<String,Object>	render(Map<String,Object> inline)
Map<String,Object>	render(Map<String,Object> inline, Map<String,Object> variables)
Set<String>	render(Set<String> inline)
Set<String>	render(Set<String> inline, Map<String,Object> variables)
Map<String,String>	renderMap(Map<String,String> inline)
Path	tempDir()
Path	tempDir(boolean create)
Path	tempFile()	Deprecated. use tempFile(String) instead
Path	tempFile(byte[] content)	Deprecated. use tempFile(byte[], String) instead
Path	tempFile(byte[] content, String extension)
Path	tempFile(String extension)
RunContext	updateVariables(WorkerTaskResult workerTaskResult, TaskRun parent)
InputStream	uriToInputStream(URI uri)
protected Map<String,Object>	variables(Flow flow, Task task, Execution execution, TaskRun taskRun, AbstractTrigger trigger)

Methods inherited from class java.lang.Object

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

Field Details

temporaryDirectory

protected transient Path temporaryDirectory

Constructor Details

RunContext

public RunContext(io.micronaut.context.ApplicationContext applicationContext,
 Flow flow,
 Execution execution)

Only used by Flow

Parameters:

applicationContext - the current ApplicationContext

flow - the current Flow

execution - the current Execution

RunContext

public RunContext(io.micronaut.context.ApplicationContext applicationContext,
 Flow flow,
 Task task,
 Execution execution,
 TaskRun taskRun)

Normal usage

Parameters:

applicationContext - the current ApplicationContext

flow - the current Flow

task - the current Task

execution - the current Execution

taskRun - the current TaskRun

RunContext

public RunContext(io.micronaut.context.ApplicationContext applicationContext,
 Flow flow,
 AbstractTrigger trigger)

Only used by AbstractTrigger, then scheduler must call forScheduler(TriggerContext, AbstractTrigger)

Parameters:

applicationContext - the current ApplicationContext

RunContext

public RunContext(io.micronaut.context.ApplicationContext applicationContext,
 Map<String,Object> variables)

Only used by Unit Test

Parameters:

applicationContext - the current ApplicationContext

variables - The variable to inject

Method Details

initBean

protected void initBean(io.micronaut.context.ApplicationContext applicationContext)

getTriggerExecutionId

public String getTriggerExecutionId()

getVariables

public Map<String,Object> getVariables()

getStorageOutputPrefix

public URI getStorageOutputPrefix()

getApplicationContext

public io.micronaut.context.ApplicationContext getApplicationContext()

variables

protected Map<String,Object> variables(Flow flow,
 Task task,
 Execution execution,
 TaskRun taskRun,
 AbstractTrigger trigger)

updateVariables

public RunContext updateVariables(WorkerTaskResult workerTaskResult,
 TaskRun parent)

forScheduler

public RunContext forScheduler(TriggerContext triggerContext,
 AbstractTrigger trigger)

forWorker

public RunContext forWorker(io.micronaut.context.ApplicationContext applicationContext,
 WorkerTask workerTask)

forWorker

public RunContext forWorker(io.micronaut.context.ApplicationContext applicationContext,
 WorkerTrigger workerTrigger)

forWorkerDirectory

public RunContext forWorkerDirectory(io.micronaut.context.ApplicationContext applicationContext,
 WorkerTask workerTask)

render

public String render(String inline)
              throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public String render(String inline,
 Map<String,Object> variables)
              throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public List<String> render(List<String> inline)
                    throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public List<String> render(List<String> inline,
 Map<String,Object> variables)
                    throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public Set<String> render(Set<String> inline)
                   throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public Set<String> render(Set<String> inline,
 Map<String,Object> variables)
                   throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public Map<String,Object> render(Map<String,Object> inline)
                          throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

render

public Map<String,Object> render(Map<String,Object> inline,
 Map<String,Object> variables)
                          throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

renderMap

public Map<String,String> renderMap(Map<String,String> inline)
                             throws IllegalVariableEvaluationException

Throws:

IllegalVariableEvaluationException

logger

public org.slf4j.Logger logger()

uriToInputStream

public InputStream uriToInputStream(URI uri)
                             throws IOException

Throws:

IOException

putTempFile

public URI putTempFile(File file)
                throws IOException

Put the temporary file on storage and delete it after.

Parameters:

file - the temporary file to upload to storage

Returns:

the StorageObject created

Throws:

IOException - If the temporary file can't be read

putTempFile

public URI putTempFile(File file,
 String name)
                throws IOException

Put the temporary file on storage and delete it after.

Parameters:

file - the temporary file to upload to storage

name - overwrite file name

Returns:

the StorageObject created

Throws:

IOException - If the temporary file can't be read

putTempFile

public URI putTempFile(File file,
 String executionId,
 AbstractTrigger trigger)
                throws IOException

Put the temporary file on storage and delete it after. This method is meant to be used by polling triggers, the name of the destination file is derived from the executionId and the trigger passed as parameters.

Parameters:

file - the temporary file to upload to storage

executionId - overwrite file name

trigger - the trigger

Returns:

the StorageObject created

Throws:

IOException - If the temporary file can't be read

getTaskStateFile

public InputStream getTaskStateFile(String state,
 String name)
                             throws IOException

Throws:

IOException

getTaskStateFile

public InputStream getTaskStateFile(String state,
 String name,
 Boolean isNamespace,
 Boolean useTaskRun)
                             throws IOException

Throws:

IOException

putTaskStateFile

public URI putTaskStateFile(byte[] content,
 String state,
 String name)
                     throws IOException

Throws:

IOException

putTaskStateFile

public URI putTaskStateFile(byte[] content,
 String state,
 String name,
 Boolean namespace,
 Boolean useTaskRun)
                     throws IOException

Throws:

IOException

putTaskStateFile

public URI putTaskStateFile(File file,
 String state,
 String name)
                     throws IOException

Throws:

IOException

putTaskStateFile

public URI putTaskStateFile(File file,
 String state,
 String name,
 Boolean isNamespace,
 Boolean useTaskRun)
                     throws IOException

Throws:

IOException

deleteTaskStateFile

public boolean deleteTaskStateFile(String state,
 String name)
                            throws IOException

Throws:

IOException

deleteTaskStateFile

public boolean deleteTaskStateFile(String state,
 String name,
 Boolean isNamespace,
 Boolean useTaskRun)
                            throws IOException

Throws:

IOException

getTaskCacheFile

public Optional<InputStream> getTaskCacheFile(String namespace,
 String flowId,
 String taskId,
 String value)
                                       throws IOException

Get from the internal storage the cache file corresponding to this task. If the cache file didn't exist, an empty Optional is returned.

Parameters:

namespace - the flow namespace

flowId - the flow identifier

taskId - the task identifier

value - optional, the task run value

Returns:

an Optional with the cache input stream or empty.

Throws:

IOException

getTaskCacheFileLastModifiedTime

public Optional<Long> getTaskCacheFileLastModifiedTime(String namespace,
 String flowId,
 String taskId,
 String value)
                                                throws IOException

Throws:

IOException

putTaskCacheFile

public URI putTaskCacheFile(File file,
 String namespace,
 String flowId,
 String taskId,
 String value)
                     throws IOException

Put into the internal storage the cache file corresponding to this task.

Parameters:

file - the cache as a ZIP archive

namespace - the flow namespace

flowId - the flow identifier

taskId - the task identifier

value - optional, the task run value

Returns:

the URI of the file inside the internal storage.

Throws:

IOException

deleteTaskCacheFile

public Optional<Boolean> deleteTaskCacheFile(String namespace,
 String flowId,
 String taskId,
 String value)
                                      throws IOException

Throws:

IOException

purgeStorageExecution

public List<URI> purgeStorageExecution()
                                throws IOException

Throws:

IOException

metrics

public List<AbstractMetricEntry<?>> metrics()

metric

public <T> RunContext metric(AbstractMetricEntry<T> metricEntry)

dynamicWorkerResult

public void dynamicWorkerResult(List<WorkerTaskResult> workerTaskResults)

dynamicWorkerResults

public List<WorkerTaskResult> dynamicWorkerResults()

tempDir

public Path tempDir()

tempDir

public Path tempDir(boolean create)

tempFile

@Deprecated
public Path tempFile()
              throws IOException

Deprecated.

use tempFile(String) instead

Throws:

IOException

tempFile

public Path tempFile(String extension)
              throws IOException

Throws:

IOException

tempFile

@Deprecated
public Path tempFile(byte[] content)
              throws IOException

Deprecated.

use tempFile(byte[], String) instead

Throws:

IOException

tempFile

public Path tempFile(byte[] content,
 String extension)
              throws IOException

Throws:

IOException

fileExtension

public String fileExtension(String fileName)

Get the file extension including the '.' to be used with the various methods that took a suffix.

Parameters:

fileName - the name of the file

Returns:

the file extension including the '.' or null

cleanup

public void cleanup()