Package io.github.cdklabs.projen

Interface TaskCommonOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

TaskOptions, TaskSpec

All Known Implementing Classes:

TaskCommonOptions.Jsii$Proxy, TaskOptions.Jsii$Proxy, TaskSpec.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TaskCommonOptions.Builder	builder()
default String	getCondition()	(experimental) A shell command which determines if the this task should be executed.
default String	getCwd()	(experimental) The working directory for all steps in this task (unless overridden by the step).
default String	getDescription()	(experimental) The description of this build command.
default Map<String,String>	getEnv()	(experimental) Defines environment variables for the execution of this task.
default List<String>	getRequiredEnv()	(experimental) A set of environment variables that must be defined in order to execute this task.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCondition

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

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

getCwd

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

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

Default: - process.cwd()

getDescription

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

(experimental) The description of this build command.

Default: - the task name

getEnv

@Stability(Experimental)
@Nullable
default Map<String,String> getEnv()

(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: {}

getRequiredEnv

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

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

builder

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

Returns:

a TaskCommonOptions.Builder of TaskCommonOptions