Package io.github.cdklabs.projen

Class DockerComposeServiceDescription.Builder

java.lang.Object

io.github.cdklabs.projen.DockerComposeServiceDescription.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerComposeServiceDescription>

Enclosing interface:

DockerComposeServiceDescription

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

A builder for DockerComposeServiceDescription

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerComposeServiceDescription	build()	Builds the configured instance.
DockerComposeServiceDescription.Builder	command(List<String> command)	Sets the value of DockerComposeServiceDescription.getCommand()
DockerComposeServiceDescription.Builder	dependsOn(List<? extends IDockerComposeServiceName> dependsOn)	Sets the value of DockerComposeServiceDescription.getDependsOn()
DockerComposeServiceDescription.Builder	entrypoint(List<String> entrypoint)	Sets the value of DockerComposeServiceDescription.getEntrypoint()
DockerComposeServiceDescription.Builder	environment(Map<String,String> environment)	Sets the value of DockerComposeServiceDescription.getEnvironment()
DockerComposeServiceDescription.Builder	image(String image)	Sets the value of DockerComposeServiceDescription.getImage()
DockerComposeServiceDescription.Builder	imageBuild(DockerComposeBuild imageBuild)	Sets the value of DockerComposeServiceDescription.getImageBuild()
DockerComposeServiceDescription.Builder	labels(Map<String,String> labels)	Sets the value of DockerComposeServiceDescription.getLabels()
DockerComposeServiceDescription.Builder	networks(List<? extends IDockerComposeNetworkBinding> networks)	Sets the value of DockerComposeServiceDescription.getNetworks()
DockerComposeServiceDescription.Builder	platform(String platform)	Sets the value of DockerComposeServiceDescription.getPlatform()
DockerComposeServiceDescription.Builder	ports(List<? extends DockerComposeServicePort> ports)	Sets the value of DockerComposeServiceDescription.getPorts()
DockerComposeServiceDescription.Builder	volumes(List<? extends IDockerComposeVolumeBinding> volumes)	Sets the value of DockerComposeServiceDescription.getVolumes()

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 DockerComposeServiceDescription.Builder command(List<String> command)

Sets the value of DockerComposeServiceDescription.getCommand()

Parameters:

command - Provide a command to the docker container.

Returns:

this

dependsOn

@Stability(Experimental)
public DockerComposeServiceDescription.Builder dependsOn(List<? extends IDockerComposeServiceName> dependsOn)

Sets the value of DockerComposeServiceDescription.getDependsOn()

Parameters:

dependsOn - Names of other services this service depends on.

Returns:

this

entrypoint

@Stability(Experimental)
public DockerComposeServiceDescription.Builder entrypoint(List<String> entrypoint)

Sets the value of DockerComposeServiceDescription.getEntrypoint()

Parameters:

entrypoint - Entrypoint to run in the container.

Returns:

this

environment

@Stability(Experimental)
public DockerComposeServiceDescription.Builder environment(Map<String,String> environment)

Sets the value of DockerComposeServiceDescription.getEnvironment()

Parameters:

environment - Add environment variables.

Returns:

this

image

@Stability(Experimental)
public DockerComposeServiceDescription.Builder image(String image)

Sets the value of DockerComposeServiceDescription.getImage()

Parameters:

image - Use a docker image. Note: You must specify either build or image key.

Returns:

this

imageBuild

@Stability(Experimental)
public DockerComposeServiceDescription.Builder imageBuild(DockerComposeBuild imageBuild)

Sets the value of DockerComposeServiceDescription.getImageBuild()

Parameters:

imageBuild - Build a docker image. Note: You must specify either imageBuild or image key.

Returns:

this

labels

@Stability(Experimental)
public DockerComposeServiceDescription.Builder labels(Map<String,String> labels)

Sets the value of DockerComposeServiceDescription.getLabels()

Parameters:

labels - Add labels.

Returns:

this

networks

@Stability(Experimental)
public DockerComposeServiceDescription.Builder networks(List<? extends IDockerComposeNetworkBinding> networks)

Sets the value of DockerComposeServiceDescription.getNetworks()

Parameters:

networks - Add some networks to the service.

Returns:

this

platform

@Stability(Experimental)
public DockerComposeServiceDescription.Builder platform(String platform)

Sets the value of DockerComposeServiceDescription.getPlatform()

Parameters:

platform - Add platform.

Returns:

this

ports

@Stability(Experimental)
public DockerComposeServiceDescription.Builder ports(List<? extends DockerComposeServicePort> ports)

Sets the value of DockerComposeServiceDescription.getPorts()

Parameters:

ports - Map some ports.

Returns:

this

volumes

@Stability(Experimental)
public DockerComposeServiceDescription.Builder volumes(List<? extends IDockerComposeVolumeBinding> volumes)

Sets the value of DockerComposeServiceDescription.getVolumes()

Parameters:

volumes - Mount some volumes into the service. Use one of the following to create volumes:

Returns:

this

build

@Stability(Experimental)
public DockerComposeServiceDescription build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerComposeServiceDescription

Throws:

NullPointerException - if any required attribute was not provided