io.github.cdklabs.projen.github.workflows

Class JobMatrix.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.JobMatrix.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JobMatrix>

Enclosing interface:

JobMatrix

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

A builder for JobMatrix

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JobMatrix	build() Builds the configured instance.
JobMatrix.Builder	domain(Map<String,? extends List<String>> domain) Sets the value of JobMatrix.getDomain()
JobMatrix.Builder	exclude(List<? extends Map<String,String>> exclude) Sets the value of JobMatrix.getExclude()
JobMatrix.Builder	include(List<? extends Map<String,String>> include) Sets the value of JobMatrix.getInclude()

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

domain

@Stability(value=Experimental)
public JobMatrix.Builder domain(Map<String,? extends List<String>> domain)

Sets the value of JobMatrix.getDomain()

Parameters:

domain - Each option you define in the matrix has a key and value. The keys you define become properties in the matrix context and you can reference the property in other areas of your workflow file. For example, if you define the key os that contains an array of operating systems, you can use the matrix.os property as the value of the runs-on keyword to create a job for each operating system.

Returns:

this

exclude

@Stability(value=Experimental)
public JobMatrix.Builder exclude(List<? extends Map<String,String>> exclude)

Sets the value of JobMatrix.getExclude()

Parameters:

exclude - You can remove a specific configurations defined in the build matrix using the exclude option. Using exclude removes a job defined by the build matrix.

Returns:

this

include

@Stability(value=Experimental)
public JobMatrix.Builder include(List<? extends Map<String,String>> include)

Sets the value of JobMatrix.getInclude()

Parameters:

include - You can add additional configuration options to a build matrix job that already exists. For example, if you want to use a specific version of npm when the job that uses windows-latest and version 8 of node runs, you can use include to specify that additional option.

Returns:

this

build

@Stability(value=Experimental)
public JobMatrix build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JobMatrix

Throws:

NullPointerException - if any required attribute was not provided