Package io.kestra.plugin.scripts.exec

Class AbstractExecScript

java.lang.Object
io.kestra.core.models.tasks.Task
io.kestra.plugin.scripts.exec.AbstractExecScript
All Implemented Interfaces:
io.kestra.core.models.tasks.InputFilesInterface, io.kestra.core.models.tasks.NamespaceFilesInterface, io.kestra.core.models.tasks.OutputFilesInterface, io.kestra.core.models.tasks.RunnableTask<ScriptOutput>
public abstract class AbstractExecScript extends io.kestra.core.models.tasks.Task implements io.kestra.core.models.tasks.RunnableTask<ScriptOutput>, io.kestra.core.models.tasks.NamespaceFilesInterface, io.kestra.core.models.tasks.InputFilesInterface, io.kestra.core.models.tasks.OutputFilesInterface

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.kestra.core.models.tasks.Task

    io.kestra.core.models.tasks.Task.TaskBuilder<C extends io.kestra.core.models.tasks.Task,B extends io.kestra.core.models.tasks.Task.TaskBuilder<C,B>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected List<String>
    beforeCommands
     
    protected Map<String,String>
    env
     
    protected @NotNull @NotEmpty List<String>
    interpreter
     
    protected @NotNull @NotEmpty RunnerType
    runner
     
    protected @NotNull Boolean
    warningOnStdErr
     

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

    disabled, id, retry, timeout, type

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractExecScript()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected CommandsWrapper
    commands(io.kestra.core.runners.RunContext runContext)
     
    abstract DockerOptions
    getDocker()
     
    protected DockerOptions
    injectDefaults(@NotNull DockerOptions original)
    Allow to set Docker options defaults values.

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

    findById, findById, getDescription, getDisabled, getId, getLogLevel, getRetry, getTimeout, getType, getWorkerGroup, 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.InputFilesInterface

    getInputFiles

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

    getNamespaceFiles

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

    getOutputFiles

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

    run

  • Field Details

    • runner

      @PluginProperty @NotNull @NotEmpty protected @NotNull @NotEmpty RunnerType runner

    • beforeCommands

      @PluginProperty(dynamic=true) protected List<String> beforeCommands

    • env

      @PluginProperty(additionalProperties=java.lang.String.class, dynamic=true) protected Map<String,String> env

    • warningOnStdErr

      @PluginProperty @NotNull protected @NotNull Boolean warningOnStdErr

    • interpreter

      @PluginProperty @NotNull @NotEmpty protected @NotNull @NotEmpty List<String> interpreter

  • Constructor Details

    • AbstractExecScript

      public AbstractExecScript()

  • Method Details

    • getDocker

      public abstract DockerOptions getDocker()

    • injectDefaults

      protected DockerOptions injectDefaults(@NotNull @NotNull DockerOptions original)
      Allow to set Docker options defaults values. To make it works, it is advised to set the 'docker' field like: 
      
     @Schema(
         title = "Docker options when using the `DOCKER` runner",
         defaultValue = "{image=python, pullPolicy=ALWAYS}"
     )
     @PluginProperty
     @Builder.Default
     protected DockerOptions docker = DockerOptions.builder().build();

    • commands

      protected CommandsWrapper commands(io.kestra.core.runners.RunContext runContext) throws io.kestra.core.exceptions.IllegalVariableEvaluationException
      Throws:
      io.kestra.core.exceptions.IllegalVariableEvaluationException