Package io.github.cdklabs.projen.build

Class BuildWorkflowOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.build.BuildWorkflowOptions.Jsii$Proxy

All Implemented Interfaces:

BuildWorkflowOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BuildWorkflowOptions

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

An implementation for BuildWorkflowOptions

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.build.BuildWorkflowOptions

BuildWorkflowOptions.Builder, BuildWorkflowOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(BuildWorkflowOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the BuildWorkflowOptions.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 name of a directory that includes build artifacts.
Task	getBuildTask()	(experimental) The task to execute in order to build the project.
String	getContainerImage()	(experimental) The container image to use for builds.
Map<String,String>	getEnv()	(experimental) Build environment variables.
GitIdentity	getGitIdentity()	(experimental) Git identity to use for the workflow.
Boolean	getMutableBuild()	(experimental) Automatically update files modified during builds to pull-request branches.
String	getName()	(experimental) Name of the buildfile (e.g.
JobPermissions	getPermissions()	(experimental) Permissions granted to the build job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.
List<JobStep>	getPostBuildSteps()	(experimental) Steps to execute after build.
List<JobStep>	getPreBuildSteps()	(experimental) Steps to execute before the build.
List<String>	getRunsOn()	(experimental) Github Runner selection labels.
GroupRunnerOptions	getRunsOnGroup()	(experimental) Github Runner Group selection options.
Triggers	getWorkflowTriggers()	(experimental) Build workflow triggers.
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(BuildWorkflowOptions.Builder builder)

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

Method Detail

getArtifactsDirectory

public final String getArtifactsDirectory()

Description copied from interface: BuildWorkflowOptions

(experimental) A name of a directory that includes build artifacts.

Specified by:

getArtifactsDirectory in interface BuildWorkflowOptions

getBuildTask

public final Task getBuildTask()

Description copied from interface: BuildWorkflowOptions

(experimental) The task to execute in order to build the project.

Specified by:

getBuildTask in interface BuildWorkflowOptions

getContainerImage

public final String getContainerImage()

Description copied from interface: BuildWorkflowOptions

(experimental) The container image to use for builds.

Default: - the default workflow container

Specified by:

getContainerImage in interface BuildWorkflowOptions

getEnv

public final Map<String,String> getEnv()

Description copied from interface: BuildWorkflowOptions

(experimental) Build environment variables.

Default: {}

Specified by:

getEnv in interface BuildWorkflowOptions

getGitIdentity

public final GitIdentity getGitIdentity()

Description copied from interface: BuildWorkflowOptions

(experimental) Git identity to use for the workflow.

Default: - default identity

Specified by:

getGitIdentity in interface BuildWorkflowOptions

getMutableBuild

public final Boolean getMutableBuild()

Description copied from interface: BuildWorkflowOptions

(experimental) Automatically update files modified during builds to pull-request branches.

This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

Implies that PR builds do not have anti-tamper checks.

This is enabled by default only if githubTokenSecret is set. Otherwise it is disabled, which implies that file changes that happen during build will not be pushed back to the branch.

Default: true

Specified by:

getMutableBuild in interface BuildWorkflowOptions

getName

public final String getName()

Description copied from interface: BuildWorkflowOptions

(experimental) Name of the buildfile (e.g. "build" becomes "build.yml").

Default: "build"

Specified by:

getName in interface BuildWorkflowOptions

getPermissions

public final JobPermissions getPermissions()

Description copied from interface: BuildWorkflowOptions

(experimental) Permissions granted to the build job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.

Default: `{ contents: JobPermission.WRITE }`

Specified by:

getPermissions in interface BuildWorkflowOptions

getPostBuildSteps

public final List<JobStep> getPostBuildSteps()

Description copied from interface: BuildWorkflowOptions

(experimental) Steps to execute after build.

Default: []

Specified by:

getPostBuildSteps in interface BuildWorkflowOptions

getPreBuildSteps

public final List<JobStep> getPreBuildSteps()

Description copied from interface: BuildWorkflowOptions

(experimental) Steps to execute before the build.

Default: []

Specified by:

getPreBuildSteps in interface BuildWorkflowOptions

getRunsOn

public final List<String> getRunsOn()

Description copied from interface: BuildWorkflowOptions

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Specified by:

getRunsOn in interface BuildWorkflowOptions

getRunsOnGroup

public final GroupRunnerOptions getRunsOnGroup()

Description copied from interface: BuildWorkflowOptions

(experimental) Github Runner Group selection options.

Specified by:

getRunsOnGroup in interface BuildWorkflowOptions

getWorkflowTriggers

public final Triggers getWorkflowTriggers()

Description copied from interface: BuildWorkflowOptions

(experimental) Build workflow triggers.

Default: "{ pullRequest: {}, workflowDispatch: {} }"

Specified by:

getWorkflowTriggers in interface BuildWorkflowOptions

$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