com.github.dockerjava.api.command

Interface CreateNetworkCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<CreateNetworkResponse>, SyncDockerCmd<CreateNetworkResponse>

All Known Implementing Classes:

CreateNetworkCmdImpl

public interface CreateNetworkCmd
extends SyncDockerCmd<CreateNetworkResponse>

Create a network.

Since:

RemoteApiVersion.VERSION_1_21

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CreateNetworkCmd.Exec

Method Summary

Methods

Modifier and Type	Method and Description
String	getDriver()
Network.Ipam	getIpam()
String	getName()
CreateNetworkCmd	withDriver(String driver) Name of the network driver to use.
CreateNetworkCmd	withIpamConfig(Network.Ipam.Config config) Optional custom IP scheme for the network.
CreateNetworkCmd	withName(String name) The new network's name.
CreateNetworkCmd	withOptions(Map<String,String> options) Driver specific options

Methods inherited from interface com.github.dockerjava.api.command.SyncDockerCmd

exec

Methods inherited from interface com.github.dockerjava.api.command.DockerCmd

close

Method Detail

getName

@CheckForNull
String getName()

getDriver

@CheckForNull
String getDriver()

getIpam

@CheckForNull
Network.Ipam getIpam()

withName

CreateNetworkCmd withName(@Nonnull
                        String name)

The new network's name. Required.

withIpamConfig

CreateNetworkCmd withIpamConfig(Network.Ipam.Config config)

Optional custom IP scheme for the network.

withDriver

CreateNetworkCmd withDriver(String driver)

Name of the network driver to use. Defaults to bridge.

withOptions

CreateNetworkCmd withOptions(Map<String,String> options)

Driver specific options