Class Network.Create
- java.lang.Object
-
- com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand<C>
-
- com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList<C>
-
- com.oracle.bedrock.runtime.docker.commands.Network<Network.Create>
-
- com.oracle.bedrock.runtime.docker.commands.Network.Create
-
- All Implemented Interfaces:
com.oracle.bedrock.runtime.MetaClass<com.oracle.bedrock.runtime.Application>
- Enclosing class:
- Network<C extends CommandWithArgumentList>
public static class Network.Create extends Network<Network.Create>
A representation of the Docker Network Create command.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.oracle.bedrock.runtime.docker.commands.Network
Network.Connect, Network.Create, Network.Disconnect, Network.Inspect, Network.LS, Network.Remove
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Network.CreateauxAddress(Object... address)Set the auxiliary ipv4 or ipv6 addresses used by network driver (equates to the --aux-address argument).Network.CreatedriverOpts(Object... options)Set custom driver specific options (equates to the --opt argument).Network.Creategateway(Object... address)Set the ipv4 or ipv6 Gateway for the master subnet (equates to the --gateway argument).Network.Createinternal()Restrict external access to the network (equates to the --internal argument).Network.CreateipamDriver(String driver)Set the IP Address Management Driver (equates to the --ipam-driver argument).Network.CreateipamOpts(Object... options)Set custom IPAM driver specific options (equates to the --ipam-opt argument).Network.CreateipRange(Object... range)Allocate container ip from a sub-range (equates to the --ip-range argument).Network.Createipv6()Set metadata on a network (equates to the --ipv6 argument).Network.Createlabels(Object... labels)Set metadata on a network (equates to the --label argument).Network.Createsubnet(Object... cidr)Set the subnet in CIDR format that represents a network segment (equates to the --subnet argument).protected Network.CreatewithCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> endArgs, com.oracle.bedrock.runtime.options.Argument... args)Obtain a copy of thisCommandWithArgumentListwith the addition of the specified command argumentsArguments.protected Network.CreatewithoutCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> endArgs, com.oracle.bedrock.runtime.options.Argument... args)Obtain a copy of thisCommandWithArgumentListwithout the the specified command argumentsArguments.-
Methods inherited from class com.oracle.bedrock.runtime.docker.commands.Network
connect, create, createBridge, createOverlay, disconnect, inspect, inspect, inspect, list, remove, remove
-
Methods inherited from class com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList
onLaunch, withCommandArguments, withoutCommandArguments
-
Methods inherited from class com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand
getCommandArguments, getImplementationClass, getTimeout, onLaunched, onLaunching, timeoutAfter, timeoutAfter
-
-
-
-
Method Detail
-
auxAddress
public Network.Create auxAddress(Object... address)
Set the auxiliary ipv4 or ipv6 addresses used by network driver (equates to the --aux-address argument).- Parameters:
address- values that resolve to one or more valid auxiliary ipv4 or ipv6 addresses- Returns:
- a new
Network.Createinstance that is the same as this instance with the --aux-address option applied
-
gateway
public Network.Create gateway(Object... address)
Set the ipv4 or ipv6 Gateway for the master subnet (equates to the --gateway argument).- Parameters:
address- values that resolve to one or more valid IP ranges, for example 192.168.0.100- Returns:
- a new
Network.Createinstance that is the same as this instance with the --gateway option applied
-
internal
public Network.Create internal()
Restrict external access to the network (equates to the --internal argument).- Returns:
- a new
Network.Createinstance that is the same as this instance with the --internal option applied
-
ipRange
public Network.Create ipRange(Object... range)
Allocate container ip from a sub-range (equates to the --ip-range argument).- Parameters:
range- values that resolve to one or more valid IP ranges, for example 172.28.5.0/24- Returns:
- a new
Network.Createinstance that is the same as this instance with the --ip-range option applied
-
ipamDriver
public Network.Create ipamDriver(String driver)
Set the IP Address Management Driver (equates to the --ipam-driver argument).- Parameters:
driver- the name of the IP Address Management Driver- Returns:
- a new
Network.Createinstance that is the same as this instance with the --ipam-driver option applied
-
ipamOpts
public Network.Create ipamOpts(Object... options)
Set custom IPAM driver specific options (equates to the --ipam-opt argument).- Parameters:
options- values that resolve to one or more valid IPAM driver options- Returns:
- a new
Network.Createinstance that is the same as this instance with the --ipam-opt option applied
-
ipv6
public Network.Create ipv6()
Set metadata on a network (equates to the --ipv6 argument).- Returns:
- a new
Network.Createinstance that is the same as this instance with the --ipv6 option applied
-
labels
public Network.Create labels(Object... labels)
Set metadata on a network (equates to the --label argument).- Parameters:
labels- values that resolve to one or more valid meta-data values- Returns:
- a new
Network.Createinstance that is the same as this instance with the --label option applied
-
driverOpts
public Network.Create driverOpts(Object... options)
Set custom driver specific options (equates to the --opt argument).- Parameters:
options- values that resolve to one or more valid custom driver options- Returns:
- a new
Network.Createinstance that is the same as this instance with the --opt option applied
-
subnet
public Network.Create subnet(Object... cidr)
Set the subnet in CIDR format that represents a network segment (equates to the --subnet argument).- Parameters:
cidr- values that resolve to one or more valid CIDR arguments, for example 172.28.0.0/16- Returns:
- a new
Network.Createinstance that is the same as this instance with the --subnet option applied
-
withCommandArguments
protected Network.Create withCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> endArgs, com.oracle.bedrock.runtime.options.Argument... args)
Description copied from class:CommandWithArgumentListObtain a copy of thisCommandWithArgumentListwith the addition of the specified command argumentsArguments.- Specified by:
withCommandArgumentsin classCommandWithArgumentList<Network.Create>- Parameters:
endArgs- theListofArgumentsthat appear at the end of the command lineargs- the new command to add- Returns:
- a copy of this
CommandWithArgumentListwith the addition of the specified command argumentsArguments
-
withoutCommandArguments
protected Network.Create withoutCommandArguments(List<com.oracle.bedrock.runtime.options.Argument> endArgs, com.oracle.bedrock.runtime.options.Argument... args)
Description copied from class:CommandWithArgumentListObtain a copy of thisCommandWithArgumentListwithout the the specified command argumentsArguments.- Specified by:
withoutCommandArgumentsin classCommandWithArgumentList<Network.Create>- Parameters:
endArgs- theListofArgumentsthat appear at the end of the command lineargs- the new command to add- Returns:
- a copy of this
CommandWithArgumentListwithout the specified command argumentsArguments
-
-