Package io.github.cdklabs.projen.github

Class TaskWorkflowJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.github.TaskWorkflowJob

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.090Z")
@Stability(Experimental)
public class TaskWorkflowJob
extends Component

(experimental) The primary or initial job of a TaskWorkflow.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaskWorkflowJob.Builder	(experimental) A fluent builder for TaskWorkflowJob.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TaskWorkflowJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TaskWorkflowJob(software.amazon.jsii.JsiiObjectRef objRef)
	TaskWorkflowJob(software.constructs.IConstruct scope, Task task, TaskWorkflowJobOptions options)

Method Summary

Modifier and Type	Method	Description
Object	getConcurrency()
ContainerOptions	getContainer()
Boolean	getContinueOnError()
JobDefaults	getDefaults()
Map<String,String>	getEnv()
Object	getEnvironment()
String	getIfValue()
String	getName()
List<String>	getNeeds()
Map<String,JobStepOutput>	getOutputs()
JobPermissions	getPermissions()
List<String>	getRunsOn()
GroupRunnerOptions	getRunsOnGroup()
Map<String,ContainerOptions>	getServices()
List<JobStep>	getSteps()
JobStrategy	getStrategy()
Number	getTimeoutMinutes()
Tools	getTools()

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

TaskWorkflowJob

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

TaskWorkflowJob

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

TaskWorkflowJob

@Stability(Experimental)
public TaskWorkflowJob(@NotNull
                       software.constructs.IConstruct scope,
                       @NotNull
                       Task task,
                       @NotNull
                       TaskWorkflowJobOptions options)

Parameters:

scope - should be part of the project the Task belongs to. This parameter is required.

task - the main task that is run as part of this job. This parameter is required.

options - options to configure the TaskWorkflowJob. This parameter is required.

Method Detail

getPermissions

@Stability(Experimental)
@NotNull
public JobPermissions getPermissions()

getSteps

@Stability(Experimental)
@NotNull
public List<JobStep> getSteps()

getConcurrency

@Stability(Experimental)
@Nullable
public Object getConcurrency()

getContainer

@Stability(Experimental)
@Nullable
public ContainerOptions getContainer()

getContinueOnError

@Stability(Experimental)
@Nullable
public Boolean getContinueOnError()

getDefaults

@Stability(Experimental)
@Nullable
public JobDefaults getDefaults()

getEnv

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

getEnvironment

@Stability(Experimental)
@Nullable
public Object getEnvironment()

getIfValue

@Stability(Experimental)
@Nullable
public String getIfValue()

getName

@Stability(Experimental)
@Nullable
public String getName()

getNeeds

@Stability(Experimental)
@Nullable
public List<String> getNeeds()

getOutputs

@Stability(Experimental)
@Nullable
public Map<String,JobStepOutput> getOutputs()

getRunsOn

@Stability(Experimental)
@Nullable
public List<String> getRunsOn()

getRunsOnGroup

@Stability(Experimental)
@Nullable
public GroupRunnerOptions getRunsOnGroup()

getServices

@Stability(Experimental)
@Nullable
public Map<String,ContainerOptions> getServices()

getStrategy

@Stability(Experimental)
@Nullable
public JobStrategy getStrategy()

getTimeoutMinutes

@Stability(Experimental)
@Nullable
public Number getTimeoutMinutes()

getTools

@Stability(Experimental)
@Nullable
public Tools getTools()