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 forBuildWorkflowOptions
-
-
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 protectedJsii$Proxy(BuildWorkflowOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theBuildWorkflowOptions.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)StringgetArtifactsDirectory()(experimental) A name of a directory that includes build artifacts.TaskgetBuildTask()(experimental) The task to execute in order to build the project.StringgetContainerImage()(experimental) The container image to use for builds.Map<String,String>getEnv()(experimental) Build environment variables.GitIdentitygetGitIdentity()(experimental) Git identity to use for the workflow.BooleangetMutableBuild()(experimental) Automatically update files modified during builds to pull-request branches.StringgetName()(experimental) Name of the buildfile (e.g.JobPermissionsgetPermissions()(experimental) Permissions granted to the build job To limit job permissions forcontents, 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.GroupRunnerOptionsgetRunsOnGroup()(experimental) Github Runner Group selection options.TriggersgetWorkflowTriggers()(experimental) Build workflow triggers.inthashCode()
-
-
-
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 theBuildWorkflowOptions.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:
getArtifactsDirectoryin interfaceBuildWorkflowOptions
-
getBuildTask
public final Task getBuildTask()
Description copied from interface:BuildWorkflowOptions(experimental) The task to execute in order to build the project.- Specified by:
getBuildTaskin interfaceBuildWorkflowOptions
-
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:
getContainerImagein interfaceBuildWorkflowOptions
-
getEnv
public final Map<String,String> getEnv()
Description copied from interface:BuildWorkflowOptions(experimental) Build environment variables.Default: {}
- Specified by:
getEnvin interfaceBuildWorkflowOptions
-
getGitIdentity
public final GitIdentity getGitIdentity()
Description copied from interface:BuildWorkflowOptions(experimental) Git identity to use for the workflow.Default: - default identity
- Specified by:
getGitIdentityin interfaceBuildWorkflowOptions
-
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
githubTokenSecretis 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:
getMutableBuildin interfaceBuildWorkflowOptions
-
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:
getNamein interfaceBuildWorkflowOptions
-
getPermissions
public final JobPermissions getPermissions()
Description copied from interface:BuildWorkflowOptions(experimental) Permissions granted to the build job To limit job permissions forcontents, the desired permissions have to be explicitly set, e.g.:{ contents: JobPermission.NONE }.Default: `{ contents: JobPermission.WRITE }`
- Specified by:
getPermissionsin interfaceBuildWorkflowOptions
-
getPostBuildSteps
public final List<JobStep> getPostBuildSteps()
Description copied from interface:BuildWorkflowOptions(experimental) Steps to execute after build.Default: []
- Specified by:
getPostBuildStepsin interfaceBuildWorkflowOptions
-
getPreBuildSteps
public final List<JobStep> getPreBuildSteps()
Description copied from interface:BuildWorkflowOptions(experimental) Steps to execute before the build.Default: []
- Specified by:
getPreBuildStepsin interfaceBuildWorkflowOptions
-
getRunsOn
public final List<String> getRunsOn()
Description copied from interface:BuildWorkflowOptions(experimental) Github Runner selection labels.Default: ["ubuntu-latest"]
- Specified by:
getRunsOnin interfaceBuildWorkflowOptions
-
getRunsOnGroup
public final GroupRunnerOptions getRunsOnGroup()
Description copied from interface:BuildWorkflowOptions(experimental) Github Runner Group selection options.- Specified by:
getRunsOnGroupin interfaceBuildWorkflowOptions
-
getWorkflowTriggers
public final Triggers getWorkflowTriggers()
Description copied from interface:BuildWorkflowOptions(experimental) Build workflow triggers.Default: "{ pullRequest: {}, workflowDispatch: {} }"
- Specified by:
getWorkflowTriggersin interfaceBuildWorkflowOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-