Package io.github.cdklabs.projen.javascript

Class UpgradeDependenciesWorkflowOptions.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.UpgradeDependenciesWorkflowOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UpgradeDependenciesWorkflowOptions>

Enclosing interface:

UpgradeDependenciesWorkflowOptions

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

A builder for UpgradeDependenciesWorkflowOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpgradeDependenciesWorkflowOptions.Builder	assignees(List<String> assignees)	Sets the value of UpgradeDependenciesWorkflowOptions.getAssignees()
UpgradeDependenciesWorkflowOptions.Builder	branches(List<String> branches)	Sets the value of UpgradeDependenciesWorkflowOptions.getBranches()
UpgradeDependenciesWorkflowOptions	build()	Builds the configured instance.
UpgradeDependenciesWorkflowOptions.Builder	container(ContainerOptions container)	Sets the value of UpgradeDependenciesWorkflowOptions.getContainer()
UpgradeDependenciesWorkflowOptions.Builder	gitIdentity(GitIdentity gitIdentity)	Sets the value of UpgradeDependenciesWorkflowOptions.getGitIdentity()
UpgradeDependenciesWorkflowOptions.Builder	labels(List<String> labels)	Sets the value of UpgradeDependenciesWorkflowOptions.getLabels()
UpgradeDependenciesWorkflowOptions.Builder	permissions(JobPermissions permissions)	Sets the value of UpgradeDependenciesWorkflowOptions.getPermissions()
UpgradeDependenciesWorkflowOptions.Builder	projenCredentials(GithubCredentials projenCredentials)	Sets the value of UpgradeDependenciesWorkflowOptions.getProjenCredentials()
UpgradeDependenciesWorkflowOptions.Builder	runsOn(List<String> runsOn)	Sets the value of UpgradeDependenciesWorkflowOptions.getRunsOn()
UpgradeDependenciesWorkflowOptions.Builder	runsOnGroup(GroupRunnerOptions runsOnGroup)	Sets the value of UpgradeDependenciesWorkflowOptions.getRunsOnGroup()
UpgradeDependenciesWorkflowOptions.Builder	schedule(UpgradeDependenciesSchedule schedule)	Sets the value of UpgradeDependenciesWorkflowOptions.getSchedule()

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

assignees

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder assignees(List<String> assignees)

Sets the value of UpgradeDependenciesWorkflowOptions.getAssignees()

Parameters:

assignees - Assignees to add on the PR.

Returns:

this

branches

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder branches(List<String> branches)

Sets the value of UpgradeDependenciesWorkflowOptions.getBranches()

Parameters:

branches - List of branches to create PR's for.

Returns:

this

container

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder container(ContainerOptions container)

Sets the value of UpgradeDependenciesWorkflowOptions.getContainer()

Parameters:

container - Job container options.

Returns:

this

gitIdentity

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder gitIdentity(GitIdentity gitIdentity)

Sets the value of UpgradeDependenciesWorkflowOptions.getGitIdentity()

Parameters:

gitIdentity - The git identity to use for commits.

Returns:

this

labels

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder labels(List<String> labels)

Sets the value of UpgradeDependenciesWorkflowOptions.getLabels()

Parameters:

labels - Labels to apply on the PR.

Returns:

this

permissions

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

Sets the value of UpgradeDependenciesWorkflowOptions.getPermissions()

Parameters:

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

Returns:

this

projenCredentials

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder projenCredentials(GithubCredentials projenCredentials)

Sets the value of UpgradeDependenciesWorkflowOptions.getProjenCredentials()

Parameters:

projenCredentials - Choose a method for authenticating with GitHub for creating the PR. When using the default github token, PR's created by this workflow will not trigger any subsequent workflows (i.e the build workflow), so projen requires API access to be provided through e.g. a personal access token or other method.

Returns:

this

runsOn

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder runsOn(List<String> runsOn)

Sets the value of UpgradeDependenciesWorkflowOptions.getRunsOn()

Parameters:

runsOn - Github Runner selection labels.

Returns:

this

runsOnGroup

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder runsOnGroup(GroupRunnerOptions runsOnGroup)

Sets the value of UpgradeDependenciesWorkflowOptions.getRunsOnGroup()

Parameters:

runsOnGroup - Github Runner Group selection options.

Returns:

this

schedule

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions.Builder schedule(UpgradeDependenciesSchedule schedule)

Sets the value of UpgradeDependenciesWorkflowOptions.getSchedule()

Parameters:

schedule - Schedule to run on.

Returns:

this

build

@Stability(Experimental)
public UpgradeDependenciesWorkflowOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UpgradeDependenciesWorkflowOptions

Throws:

NullPointerException - if any required attribute was not provided