com.github.dockerjava.api.command

Interface BuildImageCmd

All Superinterfaces:

AsyncDockerCmd<BuildImageCmd,BuildResponseItem>, AutoCloseable, Closeable, DockerCmd<Void>

public interface BuildImageCmd
extends AsyncDockerCmd<BuildImageCmd,BuildResponseItem>

Build an image from Dockerfile.

TODO: http://docs.docker.com/reference/builder/#dockerignore

See Also:

build-image-from-a-dockerfile

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BuildImageCmd.Exec

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getBuildArgs()
AuthConfigurations	getBuildAuthConfigs()
Set<String>	getCacheFrom() "Cache-from" in API
String	getCpusetcpus()
String	getCpushares()
Set<String>	getExtraHosts()
Map<String,String>	getLabels()
Long	getMemory()
Long	getMemswap()
String	getNetworkMode()
String	getPathToDockerfile()
String	getPlatform() "platform" in API
URI	getRemote() "remote" in API
Long	getShmsize()
String	getTag() Deprecated. since docker API version 1.21 there can be multiple tags specified so use getTags()
Set<String>	getTags() Multple "t" tags.
String	getTarget()
InputStream	getTarInputStream()
Boolean	hasNoCacheEnabled() "nocache" in API
Boolean	hasPullEnabled() "pull" in API
Boolean	hasRemoveEnabled() "rm" in API
Boolean	isForcerm() "forcerm" in API
Boolean	isQuiet() "q" in API
default BuildImageResultCallback	start()
BuildImageCmd	withBaseDirectory(File baseDirectory)
BuildImageCmd	withBuildArg(String key, String value)
BuildImageCmd	withBuildAuthConfigs(AuthConfigurations authConfig)
BuildImageCmd	withCacheFrom(Set<String> cacheFrom)
BuildImageCmd	withCpusetcpus(String cpusetcpus)
BuildImageCmd	withCpushares(String cpushares)
BuildImageCmd	withDockerfile(File dockerfile)
BuildImageCmd	withDockerfilePath(String dockerfilePath)
BuildImageCmd	withExtraHosts(Set<String> extraHosts)
BuildImageCmd	withForcerm(Boolean forcerm)
BuildImageCmd	withLabels(Map<String,String> labels)
BuildImageCmd	withMemory(Long memory)
BuildImageCmd	withMemswap(Long memswap)
BuildImageCmd	withNetworkMode(String networkMode)
BuildImageCmd	withNoCache(Boolean noCache)
BuildImageCmd	withPlatform(String platform)
BuildImageCmd	withPull(Boolean pull)
BuildImageCmd	withQuiet(Boolean quiet)
BuildImageCmd	withRemote(URI remote)
BuildImageCmd	withRemove(Boolean rm)
BuildImageCmd	withShmsize(Long shmsize)
BuildImageCmd	withTag(String tag) Deprecated. since docker API version 1.21 there can be multiple tags specified so use withTags(java.util.Set)
BuildImageCmd	withTags(Set<String> tags)
BuildImageCmd	withTarget(String target)
BuildImageCmd	withTarInputStream(InputStream tarInputStream)

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

exec

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

close

Method Detail

getTarInputStream

@CheckForNull
InputStream getTarInputStream()

getBuildAuthConfigs

@CheckForNull
AuthConfigurations getBuildAuthConfigs()

getTag

@CheckForNull
 @Deprecated
String getTag()

Deprecated. since docker API version 1.21 there can be multiple tags specified so use getTags()

"t" in API

getTags

@CheckForNull
Set<String> getTags()

Multple "t" tags.

Since:

RemoteApiVersion#VERSION_1_21

getCacheFrom

@CheckForNull
Set<String> getCacheFrom()

"Cache-from" in API

getRemote

@CheckForNull
URI getRemote()

"remote" in API

hasNoCacheEnabled

@CheckForNull
Boolean hasNoCacheEnabled()

"nocache" in API

hasRemoveEnabled

@CheckForNull
Boolean hasRemoveEnabled()

"rm" in API

isForcerm

@CheckForNull
Boolean isForcerm()

"forcerm" in API

isQuiet

@CheckForNull
Boolean isQuiet()

"q" in API

hasPullEnabled

@CheckForNull
Boolean hasPullEnabled()

"pull" in API

getPathToDockerfile

@CheckForNull
String getPathToDockerfile()

getMemory

@CheckForNull
Long getMemory()

getMemswap

@CheckForNull
Long getMemswap()

getCpushares

@CheckForNull
String getCpushares()

getCpusetcpus

@CheckForNull
String getCpusetcpus()

getBuildArgs

@CheckForNull
Map<String,String> getBuildArgs()

Since:

RemoteApiVersion#VERSION_1_21

getShmsize

@CheckForNull
Long getShmsize()

Since:

RemoteApiVersion#VERSION_1_22

getLabels

@CheckForNull
Map<String,String> getLabels()

Since:

RemoteApiVersion#VERSION_1_23

getNetworkMode

@CheckForNull
String getNetworkMode()

Since:

RemoteApiVersion#VERSION_1_25

getPlatform

@CheckForNull
String getPlatform()

"platform" in API

Since:

RemoteApiVersion#VERSION_1_32

getTarget

@CheckForNull
String getTarget()

Since:

RemoteApiVersion#VERSION_1_38

getExtraHosts

@CheckForNull
Set<String> getExtraHosts()

Since:

RemoteApiVersion#VERSION_1_28

withTag

@Deprecated
BuildImageCmd withTag(String tag)

Deprecated. since docker API version 1.21 there can be multiple tags specified so use withTags(java.util.Set)

withTags

BuildImageCmd withTags(Set<String> tags)

withCacheFrom

BuildImageCmd withCacheFrom(Set<String> cacheFrom)

withRemote

BuildImageCmd withRemote(URI remote)

withBaseDirectory

BuildImageCmd withBaseDirectory(File baseDirectory)

withDockerfile

BuildImageCmd withDockerfile(File dockerfile)

withDockerfilePath

BuildImageCmd withDockerfilePath(String dockerfilePath)

withNoCache

BuildImageCmd withNoCache(Boolean noCache)

withRemove

BuildImageCmd withRemove(Boolean rm)

withForcerm

BuildImageCmd withForcerm(Boolean forcerm)

withQuiet

BuildImageCmd withQuiet(Boolean quiet)

withPull

BuildImageCmd withPull(Boolean pull)

withMemory

BuildImageCmd withMemory(Long memory)

withMemswap

BuildImageCmd withMemswap(Long memswap)

withCpushares

BuildImageCmd withCpushares(String cpushares)

withCpusetcpus

BuildImageCmd withCpusetcpus(String cpusetcpus)

withBuildArg

BuildImageCmd withBuildArg(String key,
                           String value)

Since:

RemoteApiVersion#VERSION_1_21

withBuildAuthConfigs

BuildImageCmd withBuildAuthConfigs(AuthConfigurations authConfig)

withTarInputStream

BuildImageCmd withTarInputStream(@Nonnull
                                 InputStream tarInputStream)

withShmsize

BuildImageCmd withShmsize(Long shmsize)

Since:

RemoteApiVersion#VERSION_1_22

withLabels

BuildImageCmd withLabels(Map<String,String> labels)

Since:

RemoteApiVersion#VERSION_1_23

withNetworkMode

BuildImageCmd withNetworkMode(String networkMode)

Since:

RemoteApiVersion#VERSION_1_25

withPlatform

BuildImageCmd withPlatform(String platform)

Since:

RemoteApiVersion#VERSION_1_32

withTarget

BuildImageCmd withTarget(String target)

Since:

RemoteApiVersion#VERSION_1_38

withExtraHosts

BuildImageCmd withExtraHosts(Set<String> extraHosts)

Since:

RemoteApiVersion#VERSION_1_28

start

default BuildImageResultCallback start()

Specified by:

start in interface AsyncDockerCmd<BuildImageCmd,BuildResponseItem>