Package io.github.cdklabs.projen

Class Gitpod

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.Gitpod

All Implemented Interfaces:

IDevEnvironment, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.754Z")
@Stability(Experimental)
public class Gitpod
extends Component
implements IDevEnvironment

(experimental) The Gitpod component which emits .gitpod.yml.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gitpod.Builder	(experimental) A fluent builder for Gitpod.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.IDevEnvironment

IDevEnvironment.Jsii$Default, IDevEnvironment.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	Gitpod(Project project)
	Gitpod(Project project, GitpodOptions options)
protected	Gitpod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Gitpod(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addCustomTask(GitpodTask options)	(experimental) Add a task with more granular options.
void	addDockerImage(DevEnvironmentDockerImage image)	(experimental) Add a custom Docker image or Dockerfile for the container.
void	addPorts(@NotNull String... ports)	(experimental) Add ports that should be exposed (forwarded) from the container.
void	addPrebuilds(GitpodPrebuilds config)	(experimental) Add a prebuilds configuration for the Gitpod App.
void	addTasks(@NotNull Task... tasks)	(experimental) Add tasks to run when gitpod starts.
void	addVscodeExtensions(@NotNull String... extensions)	(experimental) Add a list of VSCode extensions that should be automatically installed in the container.
Object	getConfig()	(experimental) Direct access to the gitpod configuration (escape hatch).

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Gitpod

protected Gitpod(software.amazon.jsii.JsiiObjectRef objRef)

Gitpod

protected Gitpod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Gitpod

@Stability(Experimental)
public Gitpod(@NotNull
              Project project,
              @Nullable
              GitpodOptions options)

Parameters:

project - This parameter is required.

options -

Gitpod

@Stability(Experimental)
public Gitpod(@NotNull
              Project project)

Parameters:

project - This parameter is required.

Method Detail

addCustomTask

@Stability(Experimental)
public void addCustomTask(@NotNull
                          GitpodTask options)

(experimental) Add a task with more granular options.

By default, all tasks will be run in parallel. To run tasks in sequence, create a new Task and set the other tasks as subtasks.

Parameters:

options - The task parameters. This parameter is required.

addDockerImage

@Stability(Experimental)
public void addDockerImage(@NotNull
                           DevEnvironmentDockerImage image)

(experimental) Add a custom Docker image or Dockerfile for the container.

Specified by:

addDockerImage in interface IDevEnvironment

Parameters:

image - The Docker image. This parameter is required.

addPorts

@Stability(Experimental)
public void addPorts(@NotNull
                     @NotNull String... ports)

(experimental) Add ports that should be exposed (forwarded) from the container.

Specified by:

addPorts in interface IDevEnvironment

Parameters:

ports - The new ports. This parameter is required.

addPrebuilds

@Stability(Experimental)
public void addPrebuilds(@NotNull
                         GitpodPrebuilds config)

(experimental) Add a prebuilds configuration for the Gitpod App.

Parameters:

config - The configuration. This parameter is required.

addTasks

@Stability(Experimental)
public void addTasks(@NotNull
                     @NotNull Task... tasks)

(experimental) Add tasks to run when gitpod starts.

By default, all tasks will be run in parallel. To run tasks in sequence, create a new Task and specify the other tasks as subtasks.

Specified by:

addTasks in interface IDevEnvironment

Parameters:

tasks - The new tasks. This parameter is required.

addVscodeExtensions

@Stability(Experimental)
public void addVscodeExtensions(@NotNull
                                @NotNull String... extensions)

(experimental) Add a list of VSCode extensions that should be automatically installed in the container.

These must be in the format defined in the Open VSX registry.

Example:

 'scala-lang.scala@0.3.9:O5XmjwY5Gz+0oDZAmqneJw=='
 

Specified by:

addVscodeExtensions in interface IDevEnvironment

Parameters:

extensions - The extension IDs. This parameter is required.

See Also:

https://www.gitpod.io/docs/vscode-extensions/

getConfig

@Stability(Experimental)
@NotNull
public Object getConfig()

(experimental) Direct access to the gitpod configuration (escape hatch).