Package io.github.cdklabs.projen

Class TaskStepOptions.Builder

java.lang.Object

io.github.cdklabs.projen.TaskStepOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskStepOptions>

Enclosing interface:

TaskStepOptions

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

A builder for TaskStepOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TaskStepOptions.Builder	args(List<String> args)	Sets the value of TaskStepOptions.getArgs()
TaskStepOptions	build()	Builds the configured instance.
TaskStepOptions.Builder	condition(String condition)	Sets the value of TaskStepOptions.getCondition()
TaskStepOptions.Builder	cwd(String cwd)	Sets the value of TaskStepOptions.getCwd()
TaskStepOptions.Builder	env(Map<String,String> env)	Sets the value of TaskStepOptions.getEnv()
TaskStepOptions.Builder	name(String name)	Sets the value of TaskStepOptions.getName()
TaskStepOptions.Builder	receiveArgs(Boolean receiveArgs)	Sets the value of TaskStepOptions.getReceiveArgs()

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

args

@Stability(Experimental)
public TaskStepOptions.Builder args(List<String> args)

Sets the value of TaskStepOptions.getArgs()

Parameters:

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

Returns:

this

condition

@Stability(Experimental)
public TaskStepOptions.Builder condition(String condition)

Sets the value of TaskStepOptions.getCondition()

Parameters:

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

Returns:

this

cwd

@Stability(Experimental)
public TaskStepOptions.Builder cwd(String cwd)

Sets the value of TaskStepOptions.getCwd()

Parameters:

cwd - The working directory for this step.

Returns:

this

env

@Stability(Experimental)
public TaskStepOptions.Builder env(Map<String,String> env)

Sets the value of TaskStepOptions.getEnv()

Parameters:

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

Returns:

this

name

@Stability(Experimental)
public TaskStepOptions.Builder name(String name)

Sets the value of TaskStepOptions.getName()

Parameters:

name - Step name.

Returns:

this

receiveArgs

@Stability(Experimental)
public TaskStepOptions.Builder receiveArgs(Boolean receiveArgs)

Sets the value of TaskStepOptions.getReceiveArgs()

Parameters:

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

Returns:

this

build

@Stability(Experimental)
public TaskStepOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TaskStepOptions

Throws:

NullPointerException - if any required attribute was not provided