Package io.github.cdklabs.projen

Class DockerComposeVolumeConfig.Builder

java.lang.Object

io.github.cdklabs.projen.DockerComposeVolumeConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerComposeVolumeConfig>

Enclosing interface:

DockerComposeVolumeConfig

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

A builder for DockerComposeVolumeConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerComposeVolumeConfig	build()	Builds the configured instance.
DockerComposeVolumeConfig.Builder	driver(String driver)	Sets the value of DockerComposeVolumeConfig.getDriver()
DockerComposeVolumeConfig.Builder	driverOpts(Map<String,String> driverOpts)	Sets the value of DockerComposeVolumeConfig.getDriverOpts()
DockerComposeVolumeConfig.Builder	external(Boolean external)	Sets the value of DockerComposeVolumeConfig.getExternal()
DockerComposeVolumeConfig.Builder	name(String name)	Sets the value of DockerComposeVolumeConfig.getName()

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

driver

@Stability(Experimental)
public DockerComposeVolumeConfig.Builder driver(String driver)

Sets the value of DockerComposeVolumeConfig.getDriver()

Parameters:

driver - Driver to use for the volume.

Returns:

this

driverOpts

@Stability(Experimental)
public DockerComposeVolumeConfig.Builder driverOpts(Map<String,String> driverOpts)

Sets the value of DockerComposeVolumeConfig.getDriverOpts()

Parameters:

driverOpts - Options to provide to the driver.

Returns:

this

external

@Stability(Experimental)
public DockerComposeVolumeConfig.Builder external(Boolean external)

Sets the value of DockerComposeVolumeConfig.getExternal()

Parameters:

external - Set to true to indicate that the volume is externally created.

Returns:

this

name

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

Sets the value of DockerComposeVolumeConfig.getName()

Parameters:

name - Name of the volume for when the volume name isn't going to work in YAML.

Returns:

this

build

@Stability(Experimental)
public DockerComposeVolumeConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerComposeVolumeConfig

Throws:

NullPointerException - if any required attribute was not provided