Package io.github.cdklabs.projen

Class TaskRuntime

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.TaskRuntime

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

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

(experimental) The runtime component of the tasks engine.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static String	MANIFEST_FILE	(experimental) The project-relative path of the tasks manifest file.

Constructor Summary

Constructors

Modifier	Constructor	Description
	TaskRuntime(String workdir)
protected	TaskRuntime(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TaskRuntime(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
TasksManifest	getManifest()	(experimental) The contents of tasks.json.
List<TaskSpec>	getTasks()	(experimental) The tasks in this project.
String	getWorkdir()	(experimental) The root directory of the project and the cwd for executing tasks.
void	runTask(String name)	(experimental) Runs the task.
void	runTask(String name, List<String> parents)	(experimental) Runs the task.
void	runTask(String name, List<String> parents, List<Object> args)	(experimental) Runs the task.
TaskSpec	tryFindTask(String name)	(experimental) Find a task by name, or undefined if not found.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

MANIFEST_FILE

@Stability(Experimental)
public static final String MANIFEST_FILE

(experimental) The project-relative path of the tasks manifest file.

Constructor Detail

TaskRuntime

protected TaskRuntime(software.amazon.jsii.JsiiObjectRef objRef)

TaskRuntime

protected TaskRuntime(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TaskRuntime

@Stability(Experimental)
public TaskRuntime(@NotNull
                   String workdir)

Parameters:

workdir - This parameter is required.

Method Detail

runTask

@Stability(Experimental)
public void runTask(@NotNull
                    String name,
                    @Nullable
                    List<String> parents,
                    @Nullable
                    List<Object> args)

(experimental) Runs the task.

Parameters:

name - The task name. This parameter is required.

parents -

args -

runTask

@Stability(Experimental)
public void runTask(@NotNull
                    String name,
                    @Nullable
                    List<String> parents)

(experimental) Runs the task.

Parameters:

name - The task name. This parameter is required.

parents -

runTask

@Stability(Experimental)
public void runTask(@NotNull
                    String name)

(experimental) Runs the task.

Parameters:

name - The task name. This parameter is required.

tryFindTask

@Stability(Experimental)
@Nullable
public TaskSpec tryFindTask(@NotNull
                            String name)

(experimental) Find a task by name, or undefined if not found.

Parameters:

name - This parameter is required.

getManifest

@Stability(Experimental)
@NotNull
public TasksManifest getManifest()

(experimental) The contents of tasks.json.

getTasks

@Stability(Experimental)
@NotNull
public List<TaskSpec> getTasks()

(experimental) The tasks in this project.

getWorkdir

@Stability(Experimental)
@NotNull
public String getWorkdir()

(experimental) The root directory of the project and the cwd for executing tasks.