com.github.dockerjava.api.command

Interface CopyArchiveToContainerCmd

All Superinterfaces:

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

All Known Implementing Classes:

CopyArchiveToContainerCmdImpl

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CopyArchiveToContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.Void	exec()
java.lang.String	getContainerId()
java.lang.String	getHostResource()
java.lang.String	getRemotePath()
java.io.InputStream	getTarInputStream()
boolean	isDirChildrenOnly()
boolean	isNoOverwriteDirNonDir()
CopyArchiveToContainerCmd	withContainerId(java.lang.String containerId) Set container's id
CopyArchiveToContainerCmd	withDirChildrenOnly(boolean dirChildrenOnly) If this flag is set to true, all children of the local directory will be copied to the remote without the root directory.
CopyArchiveToContainerCmd	withHostResource(java.lang.String resource) Set path to the resource on the host machine
CopyArchiveToContainerCmd	withNoOverwriteDirNonDir(boolean noOverwriteDirNonDir) If set to true then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa
CopyArchiveToContainerCmd	withRemotePath(java.lang.String remotePath)
CopyArchiveToContainerCmd	withTarInputStream(java.io.InputStream tarInputStream) Set the tar input stream that will be uploaded to the container.

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

close

Method Detail

getContainerId

java.lang.String getContainerId()

getHostResource

java.lang.String getHostResource()

getTarInputStream

java.io.InputStream getTarInputStream()

isNoOverwriteDirNonDir

boolean isNoOverwriteDirNonDir()

isDirChildrenOnly

boolean isDirChildrenOnly()

withContainerId

CopyArchiveToContainerCmd withContainerId(java.lang.String containerId)

Set container's id

Parameters:

containerId - id of the container to copy file to

withHostResource

CopyArchiveToContainerCmd withHostResource(java.lang.String resource)

Set path to the resource on the host machine

Parameters:

resource - path to the resource on the host machine

withTarInputStream

CopyArchiveToContainerCmd withTarInputStream(java.io.InputStream tarInputStream)

Set the tar input stream that will be uploaded to the container. withHostResource or withTarInputStream can be defined but not both.

Parameters:

tarInputStream - the stream to upload to the container

withNoOverwriteDirNonDir

CopyArchiveToContainerCmd withNoOverwriteDirNonDir(boolean noOverwriteDirNonDir)

If set to true then it will be an error if unpacking the given content would cause an existing directory to be replaced with a non-directory and vice versa

Parameters:

noOverwriteDirNonDir - flag to know if non directory can be overwritten

withDirChildrenOnly

CopyArchiveToContainerCmd withDirChildrenOnly(boolean dirChildrenOnly)

If this flag is set to true, all children of the local directory will be copied to the remote without the root directory. For ex: if I have root/titi and root/tata and the remote path is /var/data. dirChildrenOnly = true will create /var/data/titi and /var/data/tata dirChildrenOnly = false will create /var/data/root/titi and /var/data/root/tata

Parameters:

dirChildrenOnly - if root directory is ignored

getRemotePath

java.lang.String getRemotePath()

withRemotePath

CopyArchiveToContainerCmd withRemotePath(java.lang.String remotePath)

exec

java.lang.Void exec()
             throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.lang.Void>

Throws:

NotFoundException