Package io.github.cdklabs.projen.gitlab

Class CiConfigurationOptions.Builder

java.lang.Object

io.github.cdklabs.projen.gitlab.CiConfigurationOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CiConfigurationOptions>

Enclosing interface:

CiConfigurationOptions

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

A builder for CiConfigurationOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CiConfigurationOptions	build()	Builds the configured instance.
CiConfigurationOptions.Builder	defaultValue(Default defaultValue)	Sets the value of CiConfigurationOptions.getDefaultValue()
CiConfigurationOptions.Builder	jobs(Map<String,? extends Job> jobs)	Sets the value of CiConfigurationOptions.getJobs()
CiConfigurationOptions.Builder	pages(Job pages)	Sets the value of CiConfigurationOptions.getPages()
CiConfigurationOptions.Builder	stages(List<String> stages)	Sets the value of CiConfigurationOptions.getStages()
CiConfigurationOptions.Builder	variables(Map<String,? extends Object> variables)	Sets the value of CiConfigurationOptions.getVariables()
CiConfigurationOptions.Builder	workflow(Workflow workflow)	Sets the value of CiConfigurationOptions.getWorkflow()

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

defaultValue

@Stability(Experimental)
public CiConfigurationOptions.Builder defaultValue(Default defaultValue)

Sets the value of CiConfigurationOptions.getDefaultValue()

Parameters:

defaultValue - Default settings for the CI Configuration. Jobs that do not define one or more of the listed keywords use the value defined in the default section.

Returns:

this

jobs

@Stability(Experimental)
public CiConfigurationOptions.Builder jobs(Map<String,? extends Job> jobs)

Sets the value of CiConfigurationOptions.getJobs()

Parameters:

jobs - An initial set of jobs to add to the configuration.

Returns:

this

pages

@Stability(Experimental)
public CiConfigurationOptions.Builder pages(Job pages)

Sets the value of CiConfigurationOptions.getPages()

Parameters:

pages - A special job used to upload static sites to Gitlab pages. Requires a public/ directory with artifacts.path pointing to it.

Returns:

this

stages

@Stability(Experimental)
public CiConfigurationOptions.Builder stages(List<String> stages)

Sets the value of CiConfigurationOptions.getStages()

Parameters:

stages - Groups jobs into stages. All jobs in one stage must complete before next stage is executed. If no stages are specified. Defaults to ['build', 'test', 'deploy'].

Returns:

this

variables

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

Sets the value of CiConfigurationOptions.getVariables()

Parameters:

variables - Global variables that are passed to jobs. If the job already has that variable defined, the job-level variable takes precedence.

Returns:

this

workflow

@Stability(Experimental)
public CiConfigurationOptions.Builder workflow(Workflow workflow)

Sets the value of CiConfigurationOptions.getWorkflow()

Parameters:

workflow - Used to control pipeline behavior.

Returns:

this

build

@Stability(Experimental)
public CiConfigurationOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CiConfigurationOptions

Throws:

NullPointerException - if any required attribute was not provided