com.github.dockerjava.api.command

Interface CreateNetworkCmd

All Superinterfaces:

java.lang.AutoCloseable, java.io.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

Modifier and Type	Method and Description
java.lang.Boolean	getAttachable()
java.lang.Boolean	getCheckDuplicate()
java.lang.String	getDriver()
java.lang.Boolean	getEnableIPv6()
java.lang.Boolean	getInternal()
Network.Ipam	getIpam()
java.util.Map<java.lang.String,java.lang.String>	getLabels()
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.String>	getOptions()
CreateNetworkCmd	withAttachable(java.lang.Boolean attachable) If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network.
CreateNetworkCmd	withCheckDuplicate(boolean checkForDuplicate)
CreateNetworkCmd	withDriver(java.lang.String driver) Name of the network driver to use.
CreateNetworkCmd	withEnableIpv6(boolean enableIpv6)
CreateNetworkCmd	withInternal(boolean internal)
CreateNetworkCmd	withIpam(Network.Ipam ipam) Ipam config, such es subnet, gateway and ip range of the network
CreateNetworkCmd	withLabels(java.util.Map<java.lang.String,java.lang.String> labels) Add label for network
CreateNetworkCmd	withName(java.lang.String name) The new network's name.
CreateNetworkCmd	withOptions(java.util.Map<java.lang.String,java.lang.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
java.lang.String getName()

getDriver

@CheckForNull
java.lang.String getDriver()

getIpam

@CheckForNull
Network.Ipam getIpam()

getOptions

@CheckForNull
java.util.Map<java.lang.String,java.lang.String> getOptions()

getCheckDuplicate

@CheckForNull
java.lang.Boolean getCheckDuplicate()

getInternal

@CheckForNull
java.lang.Boolean getInternal()

getEnableIPv6

@CheckForNull
java.lang.Boolean getEnableIPv6()

getAttachable

@CheckForNull
java.lang.Boolean getAttachable()

getLabels

@CheckForNull
java.util.Map<java.lang.String,java.lang.String> getLabels()

withName

CreateNetworkCmd withName(@Nonnull
                          java.lang.String name)

The new network's name. Required.

withDriver

CreateNetworkCmd withDriver(java.lang.String driver)

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

withIpam

CreateNetworkCmd withIpam(Network.Ipam ipam)

Ipam config, such es subnet, gateway and ip range of the network

withOptions

CreateNetworkCmd withOptions(java.util.Map<java.lang.String,java.lang.String> options)

Driver specific options

withCheckDuplicate

CreateNetworkCmd withCheckDuplicate(boolean checkForDuplicate)

withInternal

CreateNetworkCmd withInternal(boolean internal)

withEnableIpv6

CreateNetworkCmd withEnableIpv6(boolean enableIpv6)

withAttachable

CreateNetworkCmd withAttachable(java.lang.Boolean attachable)

If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network.

Since:

RemoteApiVersion.VERSION_1_21

withLabels

CreateNetworkCmd withLabels(java.util.Map<java.lang.String,java.lang.String> labels)

Add label for network

Since:

RemoteApiVersion.VERSION_1_24