com.github.dockerjava.api.command

Interface CopyFileFromContainerCmd

All Superinterfaces:

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

public interface CopyFileFromContainerCmd
extends SyncDockerCmd<java.io.InputStream>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CopyFileFromContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	exec() Its the responsibility of the caller to consume and/or close the InputStream to prevent connection leaks.
java.lang.String	getContainerId()
java.lang.String	getHostPath()
java.lang.String	getResource()
CopyFileFromContainerCmd	withContainerId(java.lang.String containerId)
CopyFileFromContainerCmd	withHostPath(java.lang.String hostPath)
CopyFileFromContainerCmd	withResource(java.lang.String resource)

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

close

Method Detail

getContainerId

@CheckForNull
java.lang.String getContainerId()

getHostPath

@CheckForNull
java.lang.String getHostPath()

getResource

@CheckForNull
java.lang.String getResource()

withContainerId

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

withHostPath

CopyFileFromContainerCmd withHostPath(java.lang.String hostPath)

withResource

CopyFileFromContainerCmd withResource(@Nonnull
                                      java.lang.String resource)

exec

java.io.InputStream exec()
                  throws NotFoundException

Its the responsibility of the caller to consume and/or close the InputStream to prevent connection leaks.

Specified by:

exec in interface SyncDockerCmd<java.io.InputStream>

Throws:

NotFoundException - No such container