io.github.cdklabs.projen.github.workflows

Class JobStep.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.JobStep.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JobStep>

Enclosing interface:

JobStep

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

A builder for JobStep

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JobStep	build() Builds the configured instance.
JobStep.Builder	continueOnError(Boolean continueOnError) Sets the value of JobStep.getContinueOnError()
JobStep.Builder	env(Map<String,String> env) Sets the value of JobStep.getEnv()
JobStep.Builder	id(String id) Sets the value of JobStep.getId()
JobStep.Builder	ifValue(String ifValue) Sets the value of JobStep.getIfValue()
JobStep.Builder	name(String name) Sets the value of JobStep.getName()
JobStep.Builder	run(String run) Sets the value of JobStep.getRun()
JobStep.Builder	timeoutMinutes(Number timeoutMinutes) Sets the value of JobStep.getTimeoutMinutes()
JobStep.Builder	uses(String uses) Sets the value of JobStep.getUses()
JobStep.Builder	with(Map<String,? extends Object> with) Sets the value of JobStep.getWith()

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

continueOnError

@Stability(value=Experimental)
public JobStep.Builder continueOnError(Boolean continueOnError)

Sets the value of JobStep.getContinueOnError()

Parameters:

continueOnError - Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.

Returns:

this

env

@Stability(value=Experimental)
public JobStep.Builder env(Map<String,String> env)

Sets the value of JobStep.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(value=Experimental)
public JobStep.Builder id(String id)

Sets the value of JobStep.getId()

Parameters:

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

Returns:

this

ifValue

@Stability(value=Experimental)
public JobStep.Builder ifValue(String ifValue)

Sets the value of JobStep.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(value=Experimental)
public JobStep.Builder name(String name)

Sets the value of JobStep.getName()

Parameters:

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

Returns:

this

run

@Stability(value=Experimental)
public JobStep.Builder run(String run)

Sets the value of JobStep.getRun()

Parameters:

run - Runs command-line programs using the operating system's shell. If you do not provide a name, the step name will default to the text specified in the run command.

Returns:

this

timeoutMinutes

@Stability(value=Experimental)
public JobStep.Builder timeoutMinutes(Number timeoutMinutes)

Sets the value of JobStep.getTimeoutMinutes()

Parameters:

timeoutMinutes - The maximum number of minutes to run the step before killing the process.

Returns:

this

uses

@Stability(value=Experimental)
public JobStep.Builder uses(String uses)

Sets the value of JobStep.getUses()

Parameters:

uses - Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.

Returns:

this

with

@Stability(value=Experimental)
public JobStep.Builder with(Map<String,? extends Object> with)

Sets the value of JobStep.getWith()

Parameters:

with - A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JobStep

Throws:

NullPointerException - if any required attribute was not provided