Package io.github.cdklabs.projen.github

Class TaskWorkflowOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.TaskWorkflowOptions.Jsii$Proxy

All Implemented Interfaces:

TaskWorkflowJobOptions, TaskWorkflowOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

TaskWorkflowOptions

@Stability(Experimental)
@Internal
public static final class TaskWorkflowOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements TaskWorkflowOptions

An implementation for TaskWorkflowOptions

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.github.TaskWorkflowOptions

TaskWorkflowOptions.Builder, TaskWorkflowOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(TaskWorkflowOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the TaskWorkflowOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getArtifactsDirectory()	(experimental) A directory name which contains artifacts to be uploaded (e.g.
CheckoutWith	getCheckoutWith()	(experimental) Override for the with property of the source code checkout step.
String	getCondition()	(experimental) Adds an 'if' condition to the workflow.
ContainerOptions	getContainer()	Default: - default image
Boolean	getDownloadLfs()	(experimental) Whether to download files from Git LFS for this workflow.
Map<String,String>	getEnv()	(experimental) Workflow environment variables.
GitIdentity	getGitIdentity()	(experimental) The git identity to use in this workflow.
JobDefaults	getJobDefaults()	(experimental) Default settings for all steps in the TaskWorkflow Job.
String	getJobId()	(experimental) The primary job id.
String	getName()	(experimental) The workflow name.
Map<String,JobStepOutput>	getOutputs()	(experimental) Mapping of job output names to values/expressions.
JobPermissions	getPermissions()	(experimental) Permissions for the build job.
List<JobStep>	getPostBuildSteps()	(experimental) Actions to run after the main build step.
List<JobStep>	getPreBuildSteps()	(experimental) Steps to run before the main build step.
List<JobStep>	getPreCheckoutSteps()	(experimental) Initial steps to run before the source code checkout.
List<String>	getRunsOn()	(experimental) Github Runner selection labels.
GroupRunnerOptions	getRunsOnGroup()	(experimental) Github Runner Group selection options.
Task	getTask()	(experimental) The main task to be executed.
Triggers	getTriggers()	(experimental) The triggers for the workflow.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(TaskWorkflowOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the TaskWorkflowOptions.Builder.

Method Detail

getName

public final String getName()

Description copied from interface: TaskWorkflowOptions

(experimental) The workflow name.

Specified by:

getName in interface TaskWorkflowOptions

getTask

public final Task getTask()

Description copied from interface: TaskWorkflowOptions

(experimental) The main task to be executed.

Specified by:

getTask in interface TaskWorkflowOptions

getJobId

public final String getJobId()

Description copied from interface: TaskWorkflowOptions

(experimental) The primary job id.

Default: "build"

Specified by:

getJobId in interface TaskWorkflowOptions

getTriggers

public final Triggers getTriggers()

Description copied from interface: TaskWorkflowOptions

(experimental) The triggers for the workflow.

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

Specified by:

getTriggers in interface TaskWorkflowOptions

getPermissions

public final JobPermissions getPermissions()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Permissions for the build job.

Specified by:

getPermissions in interface TaskWorkflowJobOptions

getArtifactsDirectory

public final String getArtifactsDirectory()

Description copied from interface: TaskWorkflowJobOptions

(experimental) A directory name which contains artifacts to be uploaded (e.g. dist). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail.

Default: - not set

Specified by:

getArtifactsDirectory in interface TaskWorkflowJobOptions

getCheckoutWith

public final CheckoutWith getCheckoutWith()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Override for the with property of the source code checkout step.

Default: - not set

Specified by:

getCheckoutWith in interface TaskWorkflowJobOptions

getCondition

public final String getCondition()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Adds an 'if' condition to the workflow.

Specified by:

getCondition in interface TaskWorkflowJobOptions

getContainer

public final ContainerOptions getContainer()

Description copied from interface: TaskWorkflowJobOptions

Default: - default image

Specified by:

getContainer in interface TaskWorkflowJobOptions

getDownloadLfs

public final Boolean getDownloadLfs()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Whether to download files from Git LFS for this workflow.

Default: - Use the setting on the corresponding GitHub project

Specified by:

getDownloadLfs in interface TaskWorkflowJobOptions

getEnv

public final Map<String,String> getEnv()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Workflow environment variables.

Default: {}

Specified by:

getEnv in interface TaskWorkflowJobOptions

getGitIdentity

public final GitIdentity getGitIdentity()

Description copied from interface: TaskWorkflowJobOptions

(experimental) The git identity to use in this workflow.

Specified by:

getGitIdentity in interface TaskWorkflowJobOptions

getJobDefaults

public final JobDefaults getJobDefaults()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Default settings for all steps in the TaskWorkflow Job.

Specified by:

getJobDefaults in interface TaskWorkflowJobOptions

getOutputs

public final Map<String,JobStepOutput> getOutputs()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Mapping of job output names to values/expressions.

Default: {}

Specified by:

getOutputs in interface TaskWorkflowJobOptions

getPostBuildSteps

public final List<JobStep> getPostBuildSteps()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Actions to run after the main build step.

Default: - not set

Specified by:

getPostBuildSteps in interface TaskWorkflowJobOptions

getPreBuildSteps

public final List<JobStep> getPreBuildSteps()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Steps to run before the main build step.

Default: - not set

Specified by:

getPreBuildSteps in interface TaskWorkflowJobOptions

getPreCheckoutSteps

public final List<JobStep> getPreCheckoutSteps()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Initial steps to run before the source code checkout.

Default: - not set

Specified by:

getPreCheckoutSteps in interface TaskWorkflowJobOptions

getRunsOn

public final List<String> getRunsOn()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Specified by:

getRunsOn in interface TaskWorkflowJobOptions

getRunsOnGroup

public final GroupRunnerOptions getRunsOnGroup()

Description copied from interface: TaskWorkflowJobOptions

(experimental) Github Runner Group selection options.

Specified by:

getRunsOnGroup in interface TaskWorkflowJobOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object