io.github.cdklabs.projen

Class Task.Builder

java.lang.Object

io.github.cdklabs.projen.Task.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Task>

Enclosing class:

Task

@Stability(value=Experimental)
public static final class Task.Builder
extends Object
implements software.amazon.jsii.Builder<Task>

(experimental) A fluent builder for Task.

Method Summary

Modifier and Type	Method and Description
Task	build()
Task.Builder	condition(String condition) (experimental) A shell command which determines if the this task should be executed.
static Task.Builder	create(String name)
Task.Builder	cwd(String cwd) (experimental) The working directory for all steps in this task (unless overridden by the step).
Task.Builder	description(String description) (experimental) The description of this build command.
Task.Builder	env(Map<String,String> env) (experimental) Defines environment variables for the execution of this task.
Task.Builder	exec(String exec) (experimental) Shell command to execute as the first command of the task.
Task.Builder	requiredEnv(List<String> requiredEnv) (experimental) A set of environment variables that must be defined in order to execute this task.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Task.Builder create(String name)

Parameters:

name - This parameter is required.

Returns:

a new instance of Task.Builder.

condition

@Stability(value=Experimental)
public Task.Builder condition(String condition)

(experimental) A shell command which determines if the this task should be executed.

If the program exits with a zero exit code, steps will be executed. A non-zero code means that task will be skipped.

Parameters:

condition - A shell command which determines if the this task should be executed. This parameter is required.

Returns:

this

cwd

@Stability(value=Experimental)
public Task.Builder cwd(String cwd)

(experimental) The working directory for all steps in this task (unless overridden by the step).

Default: - process.cwd()

Parameters:

cwd - The working directory for all steps in this task (unless overridden by the step). This parameter is required.

Returns:

this

description

@Stability(value=Experimental)
public Task.Builder description(String description)

(experimental) The description of this build command.

Default: - the task name

Parameters:

description - The description of this build command. This parameter is required.

Returns:

this

env

@Stability(value=Experimental)
public Task.Builder env(Map<String,String> env)

(experimental) Defines environment variables for the execution of this task.

Values in this map will be evaluated in a shell, so you can do stuff like $(echo "foo").

Default: {}

Parameters:

env - Defines environment variables for the execution of this task. This parameter is required.

Returns:

this

requiredEnv

@Stability(value=Experimental)
public Task.Builder requiredEnv(List<String> requiredEnv)

(experimental) A set of environment variables that must be defined in order to execute this task.

Task execution will fail if one of these is not defined.

Parameters:

requiredEnv - A set of environment variables that must be defined in order to execute this task. This parameter is required.

Returns:

this

exec

@Stability(value=Experimental)
public Task.Builder exec(String exec)

(experimental) Shell command to execute as the first command of the task.

Default: - add steps using `task.exec(command)` or `task.spawn(subtask)`

Parameters:

exec - Shell command to execute as the first command of the task. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Task build()

Specified by:

build in interface software.amazon.jsii.Builder<Task>