Package io.github.cdklabs.projen.vscode

Class DevContainerOptions.Builder

java.lang.Object

io.github.cdklabs.projen.vscode.DevContainerOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DevContainerOptions>

Enclosing interface:

DevContainerOptions

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

A builder for DevContainerOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DevContainerOptions	build()	Builds the configured instance.
DevContainerOptions.Builder	dockerImage(DevEnvironmentDockerImage dockerImage)	Sets the value of DevEnvironmentOptions.getDockerImage()
DevContainerOptions.Builder	features(List<? extends DevContainerFeature> features)	Sets the value of DevContainerOptions.getFeatures()
DevContainerOptions.Builder	ports(List<String> ports)	Sets the value of DevEnvironmentOptions.getPorts()
DevContainerOptions.Builder	tasks(List<? extends Task> tasks)	Sets the value of DevEnvironmentOptions.getTasks()
DevContainerOptions.Builder	vscodeExtensions(List<String> vscodeExtensions)	Sets the value of DevEnvironmentOptions.getVscodeExtensions()

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

features

@Stability(Experimental)
public DevContainerOptions.Builder features(List<? extends DevContainerFeature> features)

Sets the value of DevContainerOptions.getFeatures()

Parameters:

features - An array of VSCode features that specify the features that should be installed inside the container when it is created.

Returns:

this

dockerImage

@Stability(Experimental)
public DevContainerOptions.Builder dockerImage(DevEnvironmentDockerImage dockerImage)

Sets the value of DevEnvironmentOptions.getDockerImage()

Parameters:

dockerImage - A Docker image or Dockerfile for the container.

Returns:

this

ports

@Stability(Experimental)
public DevContainerOptions.Builder ports(List<String> ports)

Sets the value of DevEnvironmentOptions.getPorts()

Parameters:

ports - An array of ports that should be exposed from the container.

Returns:

this

tasks

@Stability(Experimental)
public DevContainerOptions.Builder tasks(List<? extends Task> tasks)

Sets the value of DevEnvironmentOptions.getTasks()

Parameters:

tasks - An array of tasks that should be run when the container starts.

Returns:

this

vscodeExtensions

@Stability(Experimental)
public DevContainerOptions.Builder vscodeExtensions(List<String> vscodeExtensions)

Sets the value of DevEnvironmentOptions.getVscodeExtensions()

Parameters:

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

Returns:

this

build

@Stability(Experimental)
public DevContainerOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DevContainerOptions

Throws:

NullPointerException - if any required attribute was not provided