Package io.github.cdklabs.projen.github

Interface TaskWorkflowOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskWorkflowJobOptions

All Known Implementing Classes:

TaskWorkflowOptions.Jsii$Proxy

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

(experimental) Options to create a TaskWorkflow.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TaskWorkflowOptions.Builder	builder()
default String	getJobId()	(experimental) The primary job id.
String	getName()	(experimental) The workflow name.
Task	getTask()	(experimental) The main task to be executed.
default Triggers	getTriggers()	(experimental) The triggers for the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getArtifactsDirectory, getCheckoutWith, getCondition, getContainer, getDownloadLfs, getEnv, getGitIdentity, getJobDefaults, getOutputs, getPermissions, getPostBuildSteps, getPreBuildSteps, getPreCheckoutSteps, getRunsOn, getRunsOnGroup

Method Detail

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) The workflow name.

getTask

@Stability(Experimental)
@NotNull
Task getTask()

(experimental) The main task to be executed.

getJobId

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

(experimental) The primary job id.

Default: "build"

getTriggers

@Stability(Experimental)
@Nullable
default Triggers getTriggers()

(experimental) The triggers for the workflow.

Default: - by default workflows can only be triggered by manually.

builder

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

Returns:

a TaskWorkflowOptions.Builder of TaskWorkflowOptions