Package io.github.cdklabs.projen.github.workflows

Class StepConfiguration.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.StepConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StepConfiguration>

Enclosing interface:

StepConfiguration

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

A builder for StepConfiguration

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StepConfiguration	build()	Builds the configured instance.
StepConfiguration.Builder	env(Map<String,String> env)	Sets the value of StepConfiguration.getEnv()
StepConfiguration.Builder	id(String id)	Sets the value of StepConfiguration.getId()
StepConfiguration.Builder	ifValue(String ifValue)	Sets the value of StepConfiguration.getIfValue()
StepConfiguration.Builder	name(String name)	Sets the value of StepConfiguration.getName()
StepConfiguration.Builder	workingDirectory(String workingDirectory)	Sets the value of StepConfiguration.getWorkingDirectory()

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

env

@Stability(Experimental)
public StepConfiguration.Builder env(Map<String,String> env)

Sets the value of StepConfiguration.getEnv()

Parameters:

env - Sets environment variables for steps to use in the runner environment. You can also set environment variables for the entire workflow or a job.

Returns:

this

id

@Stability(Experimental)
public StepConfiguration.Builder id(String id)

Sets the value of StepConfiguration.getId()

Parameters:

id - A unique identifier for the step. You can use the id to reference the step in contexts.

Returns:

this

ifValue

@Stability(Experimental)
public StepConfiguration.Builder ifValue(String ifValue)

Sets the value of StepConfiguration.getIfValue()

Parameters:

ifValue - You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.

Returns:

this

name

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

Sets the value of StepConfiguration.getName()

Parameters:

name - A name for your step to display on GitHub.

Returns:

this

workingDirectory

@Stability(Experimental)
public StepConfiguration.Builder workingDirectory(String workingDirectory)

Sets the value of StepConfiguration.getWorkingDirectory()

Parameters:

workingDirectory - Specifies a working directory for a step. Overrides a job's working directory.

Returns:

this

build

@Stability(Experimental)
public StepConfiguration build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StepConfiguration

Throws:

NullPointerException - if any required attribute was not provided