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 forWorkflowJob
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WorkflowJobbuild()Builds the configured instance.WorkflowJob.Buildercontext(List<String> context)Sets the value ofWorkflowJob.getContext()WorkflowJob.Builderfilters(Filter filters)Sets the value ofWorkflowJob.getFilters()WorkflowJob.Builderidentifier(String identifier)Sets the value ofWorkflowJob.getIdentifier()WorkflowJob.Buildermatrix(Matrix matrix)Sets the value ofWorkflowJob.getMatrix()WorkflowJob.Buildername(String name)Sets the value ofWorkflowJob.getName()WorkflowJob.BuilderorbParameters(Map<String,? extends Object> orbParameters)Sets the value ofWorkflowJob.getOrbParameters()WorkflowJob.Builderrequires(List<String> requires)Sets the value ofWorkflowJob.getRequires()WorkflowJob.Buildertype(JobType type)Sets the value ofWorkflowJob.getType()
-
-
-
Method Detail
-
identifier
@Stability(Experimental) public WorkflowJob.Builder identifier(String identifier)
Sets the value ofWorkflowJob.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 ofWorkflowJob.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 ofWorkflowJob.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 ofWorkflowJob.getMatrix()- Parameters:
matrix- the value to be set.- Returns:
this
-
name
@Stability(Experimental) public WorkflowJob.Builder name(String name)
Sets the value ofWorkflowJob.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 ofWorkflowJob.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 ofWorkflowJob.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 ofWorkflowJob.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:
buildin interfacesoftware.amazon.jsii.Builder<WorkflowJob>- Returns:
- a new instance of
WorkflowJob - Throws:
NullPointerException- if any required attribute was not provided
-
-