Package io.github.cdklabs.projen

Class TaskStep.Jsii$Proxy

  • All Implemented Interfaces:
    TaskStep, TaskStepOptions, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    TaskStep
    @Stability(Experimental)
@Internal
public static final class TaskStep.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements TaskStep
    An implementation for TaskStep

    • Nested Class Summary

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Jsii$Proxy​(TaskStep.Builder builder)
      Constructor that initializes the object based on literal property values passed by the TaskStep.Builder.
      protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

      • Jsii$Proxy

        protected Jsii$Proxy​(TaskStep.Builder builder)
        Constructor that initializes the object based on literal property values passed by the TaskStep.Builder.

    • Method Detail

      • getBuiltin

        public final String getBuiltin()
        Description copied from interface: TaskStep
        (experimental) The name of a built-in task to execute.

        Built-in tasks are node.js programs baked into the projen module and as component runtime helpers.

        The name is a path relative to the projen lib/ directory (without the .task.js extension). For example, if your built in builtin task is under src/release/resolve-version.task.ts, then this would be release/resolve-version.

        Default: - do not execute a builtin task

        Specified by:
        getBuiltin in interface TaskStep

      • getExec

        public final String getExec()
        Description copied from interface: TaskStep
        (experimental) Shell command to execute.

        Default: - don't execute a shell command

        Specified by:
        getExec in interface TaskStep

      • getSay

        public final String getSay()
        Description copied from interface: TaskStep
        (experimental) Print a message.

        Default: - don't say anything

        Specified by:
        getSay in interface TaskStep

      • getSpawn

        public final String getSpawn()
        Description copied from interface: TaskStep
        (experimental) Subtask to execute.

        Default: - don't spawn a subtask

        Specified by:
        getSpawn in interface TaskStep

      • getArgs

        public final List<String> getArgs()
        Description copied from interface: TaskStepOptions
        (experimental) A list of fixed arguments always passed to the step.

        Useful to re-use existing tasks without having to re-define the whole task.\ Fixed args are always passed to the step, even if receiveArgs is false and are always passed before any args the task is called with.

        If the step executes a shell commands, args are passed through at the end of the exec shell command.\ The position of the args can be changed by including the marker $@ inside the command string.

        If the step spawns a subtask, args are passed to the subtask. The subtask must define steps receiving args for this to have any effect.

        If the step calls a builtin script, args are passed to the script. It is up to the script to use or discard the arguments.

        Default: - no arguments are passed to the step

        Example: 

         task.spawn("deploy", { args: ["--force"] });
        Specified by:
        getArgs in interface TaskStepOptions

      • getCondition

        public final String getCondition()
        Description copied from interface: TaskStepOptions
        (experimental) A shell command which determines if the this step should be executed.

        If the program exits with a zero exit code, the step will be executed. A non-zero code means the step will be skipped (subsequent task steps will still be evaluated/executed).

        Specified by:
        getCondition in interface TaskStepOptions

      • getCwd

        public final String getCwd()
        Description copied from interface: TaskStepOptions
        (experimental) The working directory for this step.

        Default: - determined by the task

        Specified by:
        getCwd in interface TaskStepOptions

      • getEnv

        public final Map<String,​String> getEnv()
        Description copied from interface: TaskStepOptions
        (experimental) Defines environment variables for the execution of this step (exec and builtin only).

        Values in this map can be simple, literal values or shell expressions that will be evaluated at runtime e.g. $(echo "foo").

        Default: - no environment variables defined in step

        Example: 

         { "foo": "bar", "boo": "$(echo baz)" }
        Specified by:
        getEnv in interface TaskStepOptions

      • getReceiveArgs

        public final Boolean getReceiveArgs()
        Description copied from interface: TaskStepOptions
        (experimental) Should this step receive args passed to the task.

        If true, args are passed through at the end of the exec shell command.\ The position of the args can be changed by including the marker $@ inside the command string.

        If the step spawns a subtask, args are passed to the subtask. The subtask must define steps receiving args for this to have any effect.

        Default: false

        Example: 

         task.exec("echo Hello $@ World!", { receiveArgs: true });
        Specified by:
        getReceiveArgs in interface TaskStepOptions

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object