Package io.github.cdklabs.projen

Class GitpodTask.Builder

java.lang.Object

io.github.cdklabs.projen.GitpodTask.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitpodTask>

Enclosing interface:

GitpodTask

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

A builder for GitpodTask

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitpodTask.Builder	before(String before)	Sets the value of GitpodTask.getBefore()
GitpodTask	build()	Builds the configured instance.
GitpodTask.Builder	command(String command)	Sets the value of GitpodTask.getCommand()
GitpodTask.Builder	init(String init)	Sets the value of GitpodTask.getInit()
GitpodTask.Builder	name(String name)	Sets the value of GitpodTask.getName()
GitpodTask.Builder	openIn(GitpodOpenIn openIn)	Sets the value of GitpodTask.getOpenIn()
GitpodTask.Builder	openMode(GitpodOpenMode openMode)	Sets the value of GitpodTask.getOpenMode()
GitpodTask.Builder	prebuild(String prebuild)	Sets the value of GitpodTask.getPrebuild()

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

command

@Stability(Experimental)
public GitpodTask.Builder command(String command)

Sets the value of GitpodTask.getCommand()

Parameters:

command - Required. This parameter is required. The shell command to run

Returns:

this

before

@Stability(Experimental)
public GitpodTask.Builder before(String before)

Sets the value of GitpodTask.getBefore()

Parameters:

before - In case you need to run something even before init, that is a requirement for both init and command, you can use the before property.

Returns:

this

init

@Stability(Experimental)
public GitpodTask.Builder init(String init)

Sets the value of GitpodTask.getInit()

Parameters:

init - The init property can be used to specify shell commands that should only be executed after a workspace was freshly cloned and needs to be initialized somehow. Such tasks are usually builds or downloading dependencies. Anything you only want to do once but not when you restart a workspace or start a snapshot.

Returns:

this

name

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

Sets the value of GitpodTask.getName()

Parameters:

name - A name for this task.

Returns:

this

openIn

@Stability(Experimental)
public GitpodTask.Builder openIn(GitpodOpenIn openIn)

Sets the value of GitpodTask.getOpenIn()

Parameters:

openIn - You can configure where in the IDE the terminal should be opened.

Returns:

this

openMode

@Stability(Experimental)
public GitpodTask.Builder openMode(GitpodOpenMode openMode)

Sets the value of GitpodTask.getOpenMode()

Parameters:

openMode - You can configure how the terminal should be opened relative to the previous task.

Returns:

this

prebuild

@Stability(Experimental)
public GitpodTask.Builder prebuild(String prebuild)

Sets the value of GitpodTask.getPrebuild()

Parameters:

prebuild - The optional prebuild command will be executed during prebuilds. It is meant to run additional long running processes that could be useful, e.g. running test suites.

Returns:

this

build

@Stability(Experimental)
public GitpodTask build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GitpodTask

Throws:

NullPointerException - if any required attribute was not provided