Package io.github.cdklabs.projen.circleci

Class Run.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Run>
    Enclosing interface:
    Run
    @Stability(Experimental)
public static final class Run.Builder
extends Object
implements software.amazon.jsii.Builder<Run>
    A builder for Run

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • command

        @Stability(Experimental)
public Run.Builder command​(String command)
        Sets the value of Run.getCommand()
        Parameters:
        command - Command to run via the shell. This parameter is required.
        Returns:
        this

      • background

        @Stability(Experimental)
public Run.Builder background​(String background)
        Sets the value of Run.getBackground()
        Parameters:
        background - Whether this step should run in the background (default: false).
        Returns:
        this

      • environment

        @Stability(Experimental)
public Run.Builder environment​(String environment)
        Sets the value of Run.getEnvironment()
        Parameters:
        environment - Additional environmental variables, locally scoped to command.
        Returns:
        this

      • name

        @Stability(Experimental)
public Run.Builder name​(String name)
        Sets the value of Run.getName()
        Parameters:
        name - Title of the step to be shown in the CircleCI UI (default: full command).
        Returns:
        this

      • noOutputTimeout

        @Stability(Experimental)
public Run.Builder noOutputTimeout​(String noOutputTimeout)
        Sets the value of Run.getNoOutputTimeout()
        Parameters:
        noOutputTimeout - Elapsed time the command can run without output such as “20m”, “1.25h”, “5s”. The default is 10 minutes.
        Returns:
        this

      • shell

        @Stability(Experimental)
public Run.Builder shell​(String shell)
        Sets the value of Run.getShell()
        Parameters:
        shell - Shell to use for execution command.
        Returns:
        this

      • when

        @Stability(Experimental)
public Run.Builder when​(String when)
        Sets the value of Run.getWhen()
        Parameters:
        when - Specify when to enable or disable the step.
        Returns:
        this

      • workingDirectory

        @Stability(Experimental)
public Run.Builder workingDirectory​(String workingDirectory)
        Sets the value of Run.getWorkingDirectory()
        Parameters:
        workingDirectory - In which directory to run this step. Will be interpreted relative to the working_directory of the job). (default: .)
        Returns:
        this

      • build

        @Stability(Experimental)
public Run build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<Run>
        Returns:
        a new instance of Run
        Throws:
        NullPointerException - if any required attribute was not provided