Package io.github.cdklabs.projen.github

Class CheckoutOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.CheckoutOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CheckoutOptions>

Enclosing interface:

CheckoutOptions

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

A builder for CheckoutOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CheckoutOptions	build()	Builds the configured instance.
CheckoutOptions.Builder	continueOnError(Boolean continueOnError)	Sets the value of JobStepConfiguration.getContinueOnError()
CheckoutOptions.Builder	env(Map<String,String> env)	Sets the value of StepConfiguration.getEnv()
CheckoutOptions.Builder	id(String id)	Sets the value of StepConfiguration.getId()
CheckoutOptions.Builder	ifValue(String ifValue)	Sets the value of StepConfiguration.getIfValue()
CheckoutOptions.Builder	name(String name)	Sets the value of StepConfiguration.getName()
CheckoutOptions.Builder	timeoutMinutes(Number timeoutMinutes)	Sets the value of JobStepConfiguration.getTimeoutMinutes()
CheckoutOptions.Builder	with(CheckoutWith with)	Sets the value of CheckoutOptions.getWith()
CheckoutOptions.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

with

@Stability(Experimental)
public CheckoutOptions.Builder with(CheckoutWith with)

Sets the value of CheckoutOptions.getWith()

Parameters:

with - Options for checkout.

Returns:

this

continueOnError

@Stability(Experimental)
public CheckoutOptions.Builder continueOnError(Boolean continueOnError)

Sets the value of JobStepConfiguration.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

timeoutMinutes

@Stability(Experimental)
public CheckoutOptions.Builder timeoutMinutes(Number timeoutMinutes)

Sets the value of JobStepConfiguration.getTimeoutMinutes()

Parameters:

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

Returns:

this

env

@Stability(Experimental)
public CheckoutOptions.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 CheckoutOptions.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 CheckoutOptions.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 CheckoutOptions.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 CheckoutOptions.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 CheckoutOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CheckoutOptions

Throws:

NullPointerException - if any required attribute was not provided