Package io.github.cdklabs.projen.build

Class BuildWorkflowCommonOptions.Builder

java.lang.Object

io.github.cdklabs.projen.build.BuildWorkflowCommonOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BuildWorkflowCommonOptions>

Enclosing interface:

BuildWorkflowCommonOptions

@Stability(Experimental)
public static final class BuildWorkflowCommonOptions.Builder
extends Object
implements software.amazon.jsii.Builder<BuildWorkflowCommonOptions>

A builder for BuildWorkflowCommonOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BuildWorkflowCommonOptions	build()	Builds the configured instance.
BuildWorkflowCommonOptions.Builder	name(String name)	Sets the value of BuildWorkflowCommonOptions.getName()
BuildWorkflowCommonOptions.Builder	permissions(JobPermissions permissions)	Sets the value of BuildWorkflowCommonOptions.getPermissions()
BuildWorkflowCommonOptions.Builder	preBuildSteps(List<? extends JobStep> preBuildSteps)	Sets the value of BuildWorkflowCommonOptions.getPreBuildSteps()
BuildWorkflowCommonOptions.Builder	workflowTriggers(Triggers workflowTriggers)	Sets the value of BuildWorkflowCommonOptions.getWorkflowTriggers()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

@Stability(Experimental)
public BuildWorkflowCommonOptions.Builder name(String name)

Sets the value of BuildWorkflowCommonOptions.getName()

Parameters:

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

Returns:

this

permissions

@Stability(Experimental)
public BuildWorkflowCommonOptions.Builder permissions(JobPermissions permissions)

Sets the value of BuildWorkflowCommonOptions.getPermissions()

Parameters:

permissions - 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 }.

Returns:

this

preBuildSteps

@Stability(Experimental)
public BuildWorkflowCommonOptions.Builder preBuildSteps(List<? extends JobStep> preBuildSteps)

Sets the value of BuildWorkflowCommonOptions.getPreBuildSteps()

Parameters:

preBuildSteps - Steps to execute before the build.

Returns:

this

workflowTriggers

@Stability(Experimental)
public BuildWorkflowCommonOptions.Builder workflowTriggers(Triggers workflowTriggers)

Sets the value of BuildWorkflowCommonOptions.getWorkflowTriggers()

Parameters:

workflowTriggers - Build workflow triggers.

Returns:

this

build

@Stability(Experimental)
public BuildWorkflowCommonOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BuildWorkflowCommonOptions>

Returns:

a new instance of BuildWorkflowCommonOptions

Throws:

NullPointerException - if any required attribute was not provided