Package io.github.cdklabs.projen.circleci

Class WorkflowJob.Builder

java.lang.Object

io.github.cdklabs.projen.circleci.WorkflowJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WorkflowJob>

Enclosing interface:

WorkflowJob

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

A builder for WorkflowJob

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WorkflowJob	build()	Builds the configured instance.
WorkflowJob.Builder	context(List<String> context)	Sets the value of WorkflowJob.getContext()
WorkflowJob.Builder	filters(Filter filters)	Sets the value of WorkflowJob.getFilters()
WorkflowJob.Builder	identifier(String identifier)	Sets the value of WorkflowJob.getIdentifier()
WorkflowJob.Builder	matrix(Matrix matrix)	Sets the value of WorkflowJob.getMatrix()
WorkflowJob.Builder	name(String name)	Sets the value of WorkflowJob.getName()
WorkflowJob.Builder	orbParameters(Map<String,? extends Object> orbParameters)	Sets the value of WorkflowJob.getOrbParameters()
WorkflowJob.Builder	requires(List<String> requires)	Sets the value of WorkflowJob.getRequires()
WorkflowJob.Builder	type(JobType type)	Sets the value of WorkflowJob.getType()

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

identifier

@Stability(Experimental)
public WorkflowJob.Builder identifier(String identifier)

Sets the value of WorkflowJob.getIdentifier()

Parameters:

identifier - name of dynamic key *. This parameter is required.

Returns:

this

context

@Stability(Experimental)
public WorkflowJob.Builder context(List<String> context)

Sets the value of WorkflowJob.getContext()

Parameters:

context - The name of the context(s). The initial default name is org-global. Each context name must be unique.

Returns:

this

filters

@Stability(Experimental)
public WorkflowJob.Builder filters(Filter filters)

Sets the value of WorkflowJob.getFilters()

Parameters:

filters - Job Filters can have the key branches or tags.

Returns:

this

matrix

@Stability(Experimental)
public WorkflowJob.Builder matrix(Matrix matrix)

Sets the value of WorkflowJob.getMatrix()

Parameters:

matrix - the value to be set.

Returns:

this

name

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

Sets the value of WorkflowJob.getName()

Parameters:

name - A replacement for the job name. Useful when calling a job multiple times

Returns:

this

orbParameters

@Stability(Experimental)
public WorkflowJob.Builder orbParameters(Map<String,? extends Object> orbParameters)

Sets the value of WorkflowJob.getOrbParameters()

Parameters:

orbParameters - Parameters passed to job when referencing a job from orb.

Returns:

this

requires

@Stability(Experimental)
public WorkflowJob.Builder requires(List<String> requires)

Sets the value of WorkflowJob.getRequires()

Parameters:

requires - A list of jobs that must succeed for the job to start.

Returns:

this

type

@Stability(Experimental)
public WorkflowJob.Builder type(JobType type)

Sets the value of WorkflowJob.getType()

Parameters:

type - A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed.

Returns:

this

build

@Stability(Experimental)
public WorkflowJob build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WorkflowJob

Throws:

NullPointerException - if any required attribute was not provided