Package io.github.cdklabs.projen.circleci

Class CircleCiProps.Builder

java.lang.Object

io.github.cdklabs.projen.circleci.CircleCiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CircleCiProps>

Enclosing interface:

CircleCiProps

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

A builder for CircleCiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CircleCiProps	build()	Builds the configured instance.
CircleCiProps.Builder	jobs(List<? extends Job> jobs)	Sets the value of CircleCiProps.getJobs()
CircleCiProps.Builder	orbs(Map<String,String> orbs)	Sets the value of CircleCiProps.getOrbs()
CircleCiProps.Builder	setup(Boolean setup)	Sets the value of CircleCiProps.getSetup()
CircleCiProps.Builder	version(Number version)	Sets the value of CircleCiProps.getVersion()
CircleCiProps.Builder	workflows(List<? extends Workflow> workflows)	Sets the value of CircleCiProps.getWorkflows()

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

jobs

@Stability(Experimental)
public CircleCiProps.Builder jobs(List<? extends Job> jobs)

Sets the value of CircleCiProps.getJobs()

Parameters:

jobs - List of Jobs to create unique steps per pipeline, e.g. json jobs: [{ identifier: "compile", docker: { image: "golang:alpine" } steps: ["checkout", run: {command: "go build ."}] }] .

Returns:

this

orbs

@Stability(Experimental)
public CircleCiProps.Builder orbs(Map<String,String> orbs)

Sets the value of CircleCiProps.getOrbs()

Parameters:

orbs - Contains a map of CirclCi Orbs json orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" } .

Returns:

this

setup

@Stability(Experimental)
public CircleCiProps.Builder setup(Boolean setup)

Sets the value of CircleCiProps.getSetup()

Parameters:

setup - The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations.

Returns:

this

version

@Stability(Experimental)
public CircleCiProps.Builder version(Number version)

Sets the value of CircleCiProps.getVersion()

Parameters:

version - pipeline version.

Returns:

this

workflows

@Stability(Experimental)
public CircleCiProps.Builder workflows(List<? extends Workflow> workflows)

Sets the value of CircleCiProps.getWorkflows()

Parameters:

workflows - List of Workflows of pipeline, e.g. json workflows: { { identifier: "build", jobs: [{ identifier: "node/install", context: ["npm"], }] } } .

Returns:

this

build

@Stability(Experimental)
public CircleCiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CircleCiProps

Throws:

NullPointerException - if any required attribute was not provided