com.github.dockerjava.api.command

Interface CreateVolumeCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<CreateVolumeResponse>, SyncDockerCmd<CreateVolumeResponse>

public interface CreateVolumeCmd
extends SyncDockerCmd<CreateVolumeResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CreateVolumeCmd.Exec

Method Summary

Modifier and Type	Method and Description
String	getDriver()
Map<String,String>	getDriverOpts()
Map<String,String>	getLabels()
String	getName()
CreateVolumeCmd	withDriver(String driver)
CreateVolumeCmd	withDriverOpts(Map<String,String> driverOpts)
CreateVolumeCmd	withLabels(Map<String,String> labels)
CreateVolumeCmd	withName(String name)

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()

getLabels

@CheckForNull
Map<String,String> getLabels()

getDriver

@CheckForNull
String getDriver()

getDriverOpts

@CheckForNull
Map<String,String> getDriverOpts()

withName

CreateVolumeCmd withName(String name)

Parameters:

name - - The new volume’s name. If not specified, Docker generates a name.

withLabels

CreateVolumeCmd withLabels(Map<String,String> labels)

Parameters:

labels - - A mapping of labels keys and values. Labels are a mechanism for applying metadata to Docker objects.

withDriver

CreateVolumeCmd withDriver(String driver)

Parameters:

driver - - Name of the volume driver to use. Defaults to local for the name.

withDriverOpts

CreateVolumeCmd withDriverOpts(Map<String,String> driverOpts)

Parameters:

driverOpts - - A mapping of driver options and values. These options are passed directly to the driver and are driver specific.