Package io.github.cdklabs.projen.github.workflows

Class CommonJobDefinition.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.CommonJobDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CommonJobDefinition>

Enclosing interface:

CommonJobDefinition

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

A builder for CommonJobDefinition

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CommonJobDefinition	build()	Builds the configured instance.
CommonJobDefinition.Builder	concurrency(Object concurrency)	Sets the value of CommonJobDefinition.getConcurrency()
CommonJobDefinition.Builder	ifValue(String ifValue)	Sets the value of CommonJobDefinition.getIfValue()
CommonJobDefinition.Builder	name(String name)	Sets the value of CommonJobDefinition.getName()
CommonJobDefinition.Builder	needs(List<String> needs)	Sets the value of CommonJobDefinition.getNeeds()
CommonJobDefinition.Builder	permissions(JobPermissions permissions)	Sets the value of CommonJobDefinition.getPermissions()
CommonJobDefinition.Builder	strategy(JobStrategy strategy)	Sets the value of CommonJobDefinition.getStrategy()

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

permissions

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

Sets the value of CommonJobDefinition.getPermissions()

Parameters:

permissions - You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. This parameter is required. Use { contents: READ } if your job only needs to clone code.

This is intentionally a required field since it is required in order to allow workflows to run in GitHub repositories with restricted default access.

Returns:

this

concurrency

@Stability(Experimental)
public CommonJobDefinition.Builder concurrency(Object concurrency)

Sets the value of CommonJobDefinition.getConcurrency()

Parameters:

concurrency - Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context.

Returns:

this

ifValue

@Stability(Experimental)
public CommonJobDefinition.Builder ifValue(String ifValue)

Sets the value of CommonJobDefinition.getIfValue()

Parameters:

ifValue - You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.

Returns:

this

name

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

Sets the value of CommonJobDefinition.getName()

Parameters:

name - The name of the job displayed on GitHub.

Returns:

this

needs

@Stability(Experimental)
public CommonJobDefinition.Builder needs(List<String> needs)

Sets the value of CommonJobDefinition.getNeeds()

Parameters:

needs - Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue.

Returns:

this

strategy

@Stability(Experimental)
public CommonJobDefinition.Builder strategy(JobStrategy strategy)

Sets the value of CommonJobDefinition.getStrategy()

Parameters:

strategy - A strategy creates a build matrix for your jobs. You can define different variations to run each job in.

Returns:

this

build

@Stability(Experimental)
public CommonJobDefinition build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CommonJobDefinition

Throws:

NullPointerException - if any required attribute was not provided