com.github.dockerjava.api.command

Interface RenameContainerCmd

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DockerCmd<java.lang.Void>, SyncDockerCmd<java.lang.Void>

All Known Implementing Classes:

RenameContainerCmdImpl

public interface RenameContainerCmd
extends SyncDockerCmd<java.lang.Void>

Rename a container.

Since:

RemoteApiVersion.VERSION_1_17

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RenameContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.Void	exec()
java.lang.String	getContainerId()
java.lang.String	getName()
RenameContainerCmd	withContainerId(java.lang.String containerId)
RenameContainerCmd	withName(java.lang.String name)

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

close

Method Detail

getContainerId

@CheckForNull
java.lang.String getContainerId()

withContainerId

RenameContainerCmd withContainerId(@Nonnull
                                   java.lang.String containerId)

getName

@CheckForNull
java.lang.String getName()

withName

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

exec

java.lang.Void exec()
             throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.lang.Void>

Throws:

NotFoundException - No such container