Package io.kestra.plugin.scripts.r

Class Commands

java.lang.Object
io.kestra.core.models.tasks.Task
io.kestra.plugin.scripts.exec.AbstractExecScript
io.kestra.plugin.scripts.r.Commands
All Implemented Interfaces:
io.kestra.core.models.Plugin, io.kestra.core.models.tasks.InputFilesInterface, io.kestra.core.models.tasks.NamespaceFilesInterface, io.kestra.core.models.tasks.OutputFilesInterface, io.kestra.core.models.tasks.RunnableTask<io.kestra.plugin.scripts.exec.scripts.models.ScriptOutput>, io.kestra.core.models.tasks.TaskInterface, io.kestra.core.models.WorkerJobLifecycle
@Plugin(examples=@Example(full=true,title="Create an R script, install required packages and execute it. Note that instead of defining the script inline, you could create the script as a dedicated R script in the embedded VS Code editor and point to its location by path. If you do so, make sure to enable namespace files by setting the `enabled` flag of the `namespaceFiles` property to `true`.",code="id: script\nnamespace: company.team\ntasks:\n - id: bash\n type: io.kestra.plugin.scripts.r.Commands\n inputFiles:\n main.R: |\n library(lubridate)\n ymd(\"20100604\");\n mdy(\"06-04-2011\");\n dmy(\"04/06/2012\")\n beforeCommands:\n - Rscript -e \'install.packages(\"lubridate\")\'\n commands:\n - Rscript main.R\n")) public class Commands extends io.kestra.plugin.scripts.exec.AbstractExecScript

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.kestra.plugin.scripts.exec.AbstractExecScript

    io.kestra.plugin.scripts.exec.AbstractExecScript.AbstractExecScriptBuilder<C extends io.kestra.plugin.scripts.exec.AbstractExecScript,B extends io.kestra.plugin.scripts.exec.AbstractExecScript.AbstractExecScriptBuilder<C,B>>

    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 @NotEmpty List<String>
    commands
     
    protected String
    containerImage
     

    Fields inherited from class io.kestra.plugin.scripts.exec.AbstractExecScript

    beforeCommands, docker, env, failFast, interpreter, runner, targetOS, taskRunner, warningOnStdErr

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

    disabled, id, retry, timeout, type

  • Constructor Summary

    Constructors
    Constructor
    Description
    Commands()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected io.kestra.plugin.scripts.exec.scripts.models.DockerOptions
    injectDefaults(io.kestra.plugin.scripts.exec.scripts.models.DockerOptions original)
     
    io.kestra.plugin.scripts.exec.scripts.models.ScriptOutput
    run(io.kestra.core.runners.RunContext runContext)
     

    Methods inherited from class io.kestra.plugin.scripts.exec.AbstractExecScript

    canEqual, commands, equals, getBeforeCommands, getBeforeCommandsWithOptions, getContainerImage, getDocker, getEnv, getExitOnErrorCommands, getFailFast, getInputFiles, getInterpreter, getNamespaceFiles, getOutputDirectory, getOutputFiles, getRunner, getTargetOS, getTaskRunner, getWarningOnStdErr, hashCode, kill, mayAddExitOnErrorCommands, toString

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

    findById, findById, getDescription, getDisabled, getId, getLogLevel, getRetry, getTimeout, getType, getWorkerGroup, isAllowFailure, isFlowable, isSendToWorkerTask

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.kestra.core.models.WorkerJobLifecycle

    stop

  • Field Details

    • containerImage

      protected String containerImage

    • commands

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

  • Constructor Details

    • Commands

      public Commands()

  • Method Details

    • injectDefaults

      protected io.kestra.plugin.scripts.exec.scripts.models.DockerOptions injectDefaults(io.kestra.plugin.scripts.exec.scripts.models.DockerOptions original)
      Overrides:
      injectDefaults in class io.kestra.plugin.scripts.exec.AbstractExecScript

    • run

      public io.kestra.plugin.scripts.exec.scripts.models.ScriptOutput run(io.kestra.core.runners.RunContext runContext) throws Exception
      Throws:
      Exception