Package io.github.cdklabs.projen

Interface TaskOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskCommonOptions

All Known Implementing Classes:

TaskOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.808Z")
@Stability(Experimental)
public interface TaskOptions
extends software.amazon.jsii.JsiiSerializable, TaskCommonOptions

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TaskOptions.Builder	A builder for TaskOptions
static class	TaskOptions.Jsii$Proxy	An implementation for TaskOptions

Method Summary

Modifier and Type	Method	Description
static TaskOptions.Builder	builder()
default List<String>	getArgs()	(experimental) Should the provided exec shell command receive fixed args.
default String	getExec()	(experimental) Shell command to execute as the first command of the task.
default Boolean	getReceiveArgs()	(experimental) Should the provided exec shell command receive args passed to the task.
default List<TaskStep>	getSteps()	(experimental) List of task steps to run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.TaskCommonOptions

getCondition, getCwd, getDescription, getEnv, getRequiredEnv

Method Detail

getArgs

@Stability(Experimental)
@Nullable
default List<String> getArgs()

(experimental) Should the provided exec shell command receive fixed args.

Default: - no arguments are passed to the step

See Also:

TaskStepOptions.args

getExec

@Stability(Experimental)
@Nullable
default String getExec()

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

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

getReceiveArgs

@Stability(Experimental)
@Nullable
default Boolean getReceiveArgs()

(experimental) Should the provided exec shell command receive args passed to the task.

Default: false

See Also:

TaskStepOptions.receiveArgs

getSteps

@Stability(Experimental)
@Nullable
default List<TaskStep> getSteps()

(experimental) List of task steps to run.

builder

@Stability(Experimental)
static TaskOptions.Builder builder()

Returns:

a TaskOptions.Builder of TaskOptions