io.github.cdklabs.projen

Class Gitpod.Builder

java.lang.Object

io.github.cdklabs.projen.Gitpod.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Gitpod>

Enclosing class:

Gitpod

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

(experimental) A fluent builder for Gitpod.

Method Summary

Modifier and Type	Method and Description
Gitpod	build()
static Gitpod.Builder	create(Project project)
Gitpod.Builder	dockerImage(DevEnvironmentDockerImage dockerImage) (experimental) A Docker image or Dockerfile for the container.
Gitpod.Builder	ports(List<String> ports) (experimental) An array of ports that should be exposed from the container.
Gitpod.Builder	prebuilds(GitpodPrebuilds prebuilds) (experimental) Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app.
Gitpod.Builder	tasks(List<? extends Task> tasks) (experimental) An array of tasks that should be run when the container starts.
Gitpod.Builder	vscodeExtensions(List<String> vscodeExtensions) (experimental) An array of extension IDs that specify the extensions that should be installed inside the container when it is created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static Gitpod.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of Gitpod.Builder.

dockerImage

@Stability(value=Experimental)
public Gitpod.Builder dockerImage(DevEnvironmentDockerImage dockerImage)

(experimental) A Docker image or Dockerfile for the container.

Parameters:

dockerImage - A Docker image or Dockerfile for the container. This parameter is required.

Returns:

this

ports

@Stability(value=Experimental)
public Gitpod.Builder ports(List<String> ports)

(experimental) An array of ports that should be exposed from the container.

Parameters:

ports - An array of ports that should be exposed from the container. This parameter is required.

Returns:

this

tasks

@Stability(value=Experimental)
public Gitpod.Builder tasks(List<? extends Task> tasks)

(experimental) An array of tasks that should be run when the container starts.

Parameters:

tasks - An array of tasks that should be run when the container starts. This parameter is required.

Returns:

this

vscodeExtensions

@Stability(value=Experimental)
public Gitpod.Builder vscodeExtensions(List<String> vscodeExtensions)

(experimental) An array of extension IDs that specify the extensions that should be installed inside the container when it is created.

Parameters:

vscodeExtensions - An array of extension IDs that specify the extensions that should be installed inside the container when it is created. This parameter is required.

Returns:

this

prebuilds

@Stability(value=Experimental)
public Gitpod.Builder prebuilds(GitpodPrebuilds prebuilds)

(experimental) Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app.

Default: undefined

Parameters:

prebuilds - Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app. This parameter is required.

Returns:

this

build

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

Specified by:

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