Package io.github.cdklabs.projen

Class DockerComposeNetworkConfig.Builder

java.lang.Object

io.github.cdklabs.projen.DockerComposeNetworkConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerComposeNetworkConfig>

Enclosing interface:

DockerComposeNetworkConfig

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

A builder for DockerComposeNetworkConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerComposeNetworkConfig.Builder	attachable(Boolean attachable)	Sets the value of DockerComposeNetworkConfig.getAttachable()
DockerComposeNetworkConfig.Builder	bridge(Boolean bridge)	Sets the value of DockerComposeNetworkConfig.getBridge()
DockerComposeNetworkConfig	build()	Builds the configured instance.
DockerComposeNetworkConfig.Builder	driver(String driver)	Sets the value of DockerComposeNetworkConfig.getDriver()
DockerComposeNetworkConfig.Builder	driverOpts(com.fasterxml.jackson.databind.node.ObjectNode driverOpts)	Sets the value of DockerComposeNetworkConfig.getDriverOpts()
DockerComposeNetworkConfig.Builder	external(Boolean external)	Sets the value of DockerComposeNetworkConfig.getExternal()
DockerComposeNetworkConfig.Builder	internal(Boolean internal)	Sets the value of DockerComposeNetworkConfig.getInternal()
DockerComposeNetworkConfig.Builder	ipam(DockerComposeNetworkIpamConfig ipam)	Sets the value of DockerComposeNetworkConfig.getIpam()
DockerComposeNetworkConfig.Builder	labels(List<String> labels)	Sets the value of DockerComposeNetworkConfig.getLabels()
DockerComposeNetworkConfig.Builder	name(String name)	Sets the value of DockerComposeNetworkConfig.getName()
DockerComposeNetworkConfig.Builder	overlay(Boolean overlay)	Sets the value of DockerComposeNetworkConfig.getOverlay()

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

attachable

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder attachable(Boolean attachable)

Sets the value of DockerComposeNetworkConfig.getAttachable()

Parameters:

attachable - Set to true to indicate that standalone containers can attach to this network, in addition to services.

Returns:

this

bridge

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder bridge(Boolean bridge)

Sets the value of DockerComposeNetworkConfig.getBridge()

Parameters:

bridge - Set to true to indicate that the network is a bridge network.

Returns:

this

driver

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

Sets the value of DockerComposeNetworkConfig.getDriver()

Parameters:

driver - Driver to use for the network.

Returns:

this

driverOpts

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder driverOpts(com.fasterxml.jackson.databind.node.ObjectNode driverOpts)

Sets the value of DockerComposeNetworkConfig.getDriverOpts()

Parameters:

driverOpts - Options for the configured driver. Those options are driver-dependent - consult the driver’s documentation for more information

Returns:

this

external

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

Sets the value of DockerComposeNetworkConfig.getExternal()

Parameters:

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

Returns:

this

internal

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder internal(Boolean internal)

Sets the value of DockerComposeNetworkConfig.getInternal()

Parameters:

internal - Set to true to indicate that you want to create an externally isolated overlay network.

Returns:

this

ipam

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder ipam(DockerComposeNetworkIpamConfig ipam)

Sets the value of DockerComposeNetworkConfig.getIpam()

Parameters:

ipam - Specify custom IPAM config.

Returns:

this

labels

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder labels(List<String> labels)

Sets the value of DockerComposeNetworkConfig.getLabels()

Parameters:

labels - Attach labels to the network.

Returns:

this

name

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

Sets the value of DockerComposeNetworkConfig.getName()

Parameters:

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

Returns:

this

overlay

@Stability(Experimental)
public DockerComposeNetworkConfig.Builder overlay(Boolean overlay)

Sets the value of DockerComposeNetworkConfig.getOverlay()

Parameters:

overlay - Set to true to indicate that the network is an overlay network.

Returns:

this

build

@Stability(Experimental)
public DockerComposeNetworkConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DockerComposeNetworkConfig

Throws:

NullPointerException - if any required attribute was not provided