io.github.cdklabs.projen

Class TaskSpec.Builder

java.lang.Object

io.github.cdklabs.projen.TaskSpec.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskSpec>

Enclosing interface:

TaskSpec

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

A builder for TaskSpec

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TaskSpec	build() Builds the configured instance.
TaskSpec.Builder	condition(String condition) Sets the value of TaskCommonOptions.getCondition()
TaskSpec.Builder	cwd(String cwd) Sets the value of TaskCommonOptions.getCwd()
TaskSpec.Builder	description(String description) Sets the value of TaskCommonOptions.getDescription()
TaskSpec.Builder	env(Map<String,String> env) Sets the value of TaskCommonOptions.getEnv()
TaskSpec.Builder	name(String name) Sets the value of TaskSpec.getName()
TaskSpec.Builder	requiredEnv(List<String> requiredEnv) Sets the value of TaskCommonOptions.getRequiredEnv()
TaskSpec.Builder	steps(List<? extends TaskStep> steps) Sets the value of TaskSpec.getSteps()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

name

@Stability(value=Experimental)
public TaskSpec.Builder name(String name)

Sets the value of TaskSpec.getName()

Parameters:

name - Task name. This parameter is required.

Returns:

this

steps

@Stability(value=Experimental)
public TaskSpec.Builder steps(List<? extends TaskStep> steps)

Sets the value of TaskSpec.getSteps()

Parameters:

steps - Task steps.

Returns:

this

condition

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

Sets the value of TaskCommonOptions.getCondition()

Parameters:

condition - 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.

Returns:

this

cwd

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

Sets the value of TaskCommonOptions.getCwd()

Parameters:

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

Returns:

this

description

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

Sets the value of TaskCommonOptions.getDescription()

Parameters:

description - The description of this build command.

Returns:

this

env

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

Sets the value of TaskCommonOptions.getEnv()

Parameters:

env - 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").

Returns:

this

requiredEnv

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

Sets the value of TaskCommonOptions.getRequiredEnv()

Parameters:

requiredEnv - 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.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TaskSpec

Throws:

NullPointerException - if any required attribute was not provided