BuildConfiguration.BuildConfigurationBuilder (JKube Kit :: Config

java.lang.Object
- org.eclipse.jkube.kit.config.image.build.BuildConfiguration.BuildConfigurationBuilder

Enclosing class:: BuildConfiguration

public static class BuildConfiguration.BuildConfigurationBuilder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BuildConfiguration.BuildConfigurationBuilder`	`addCacheFrom(String addCacheFrom)`
`BuildConfiguration.BuildConfigurationBuilder`	`arg(String argKey, String argValue)`
`BuildConfiguration.BuildConfigurationBuilder`	`args(Map<? extends String,? extends String> args)`
`BuildConfiguration.BuildConfigurationBuilder`	`assembly(AssemblyConfiguration assembly)` Specifies the assembly configuration.
`BuildConfiguration`	`build()`
`BuildConfiguration.BuildConfigurationBuilder`	`buildOptions(Map<String,String> buildOptions)` Map specifying the build options to provide to the docker daemon when building the image.
`BuildConfiguration.BuildConfigurationBuilder`	`cacheFrom(Collection<? extends String> cacheFrom)`
`BuildConfiguration.BuildConfigurationBuilder`	`cleanup(String cleanup)` Cleanup dangling (untagged) images after each build (including any containers created from them) try: tries to remove the old image but doesn't fail the build if this is not possible remove: removes old image or fails if it doesn't none: No cleanup is requested
`BuildConfiguration.BuildConfigurationBuilder`	`clearArgs()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearCacheFrom()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearEnv()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearLabels()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearPorts()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearRunCmds()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearTags()`
`BuildConfiguration.BuildConfigurationBuilder`	`clearVolumes()`
`BuildConfiguration.BuildConfigurationBuilder`	`cmd(Arguments cmd)` A command to execute by default.
`BuildConfiguration.BuildConfigurationBuilder`	`compression(ArchiveCompression compression)` The compression mode how the build archive is transmitted to the docker daemon and how docker build archives are attached to this build as sources.
`BuildConfiguration.BuildConfigurationBuilder`	`compressionString(String compressionString)`
`BuildConfiguration.BuildConfigurationBuilder`	`contextDir(String contextDir)` Path to a directory used for the build's context.
`BuildConfiguration.BuildConfigurationBuilder`	`dockerArchive(String dockerArchive)` Path to a docker archive to load an image instead of building from scratch.
`BuildConfiguration.BuildConfigurationBuilder`	`dockerArchiveFile(File dockerArchiveFile)`
`BuildConfiguration.BuildConfigurationBuilder`	`dockerFile(String dockerFile)` Path to a Dockerfile which also triggers Dockerfile mode.
`BuildConfiguration.BuildConfigurationBuilder`	`dockerFileFile(File dockerFileFile)` Path to Dockerfile to use, initialized lazily.
`BuildConfiguration.BuildConfigurationBuilder`	`entryPoint(Arguments entryPoint)` An entrypoint allows you to configure a container that will run as an executable.
`BuildConfiguration.BuildConfigurationBuilder`	`env(Map<? extends String,? extends String> env)`
`BuildConfiguration.BuildConfigurationBuilder`	`filter(String filter)` Enable and set the delimiters for property replacements.
`BuildConfiguration.BuildConfigurationBuilder`	`from(String from)` The base image which should be used for this image.
`BuildConfiguration.BuildConfigurationBuilder`	`fromExt(Map<String,String> fromExt)` Extended definition for a base image.
`BuildConfiguration.BuildConfigurationBuilder`	`healthCheck(HealthCheckConfiguration healthCheck)` Health check configuration.
`BuildConfiguration.BuildConfigurationBuilder`	`imagePullPolicy(String imagePullPolicy)` Specific pull policy for the base image.
`BuildConfiguration.BuildConfigurationBuilder`	`label(String labelKey, String labelValue)`
`BuildConfiguration.BuildConfigurationBuilder`	`labels(Map<? extends String,? extends String> labels)`
`BuildConfiguration.BuildConfigurationBuilder`	`maintainer(String maintainer)` The author (MAINTAINER) field for the generated image
`BuildConfiguration.BuildConfigurationBuilder`	`nocache(Boolean nocache)` Don't use Docker’s build cache.
`BuildConfiguration.BuildConfigurationBuilder`	`optimise(Boolean optimise)` If set to true then it will compress all the `BuildConfiguration.runCmds` into a single RUN directive so that only one image layer is created.
`BuildConfiguration.BuildConfigurationBuilder`	`port(String port)`
`BuildConfiguration.BuildConfigurationBuilder`	`ports(Collection<? extends String> ports)`
`BuildConfiguration.BuildConfigurationBuilder`	`putEnv(String putEnvKey, String putEnvValue)`
`BuildConfiguration.BuildConfigurationBuilder`	`runCmd(String runCmd)`
`BuildConfiguration.BuildConfigurationBuilder`	`runCmds(Collection<? extends String> runCmds)`
`BuildConfiguration.BuildConfigurationBuilder`	`shell(Arguments shell)` Shell to be used for the `BuildConfiguration.runCmds`.
`BuildConfiguration.BuildConfigurationBuilder`	`skip(Boolean skip)` If set to true disables building of the image.
`BuildConfiguration.BuildConfigurationBuilder`	`tag(String tag)`
`BuildConfiguration.BuildConfigurationBuilder`	`tags(Collection<? extends String> tags)`
`String`	`toString()`
`BuildConfiguration.BuildConfigurationBuilder`	`user(String user)` User to which the Dockerfile should switch to the end (corresponds to the `USER` Dockerfile directive).
`BuildConfiguration.BuildConfigurationBuilder`	`volume(String volume)`
`BuildConfiguration.BuildConfigurationBuilder`	`volumes(Collection<? extends String> volumes)`
`BuildConfiguration.BuildConfigurationBuilder`	`workdir(String workdir)` Directory to change to when starting the container.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

compressionString

public BuildConfiguration.BuildConfigurationBuilder compressionString(String compressionString)

contextDir
```
public BuildConfiguration.BuildConfigurationBuilder contextDir(String contextDir)
```
Path to a directory used for the build's context. You can specify the Dockerfile to use with dockerFile, which by default is the Dockerfile found in the contextDir. The Dockerfile can be also located outside of the contextDir, if provided with an absolute file path.

Returns:

this.

dockerFile
```
public BuildConfiguration.BuildConfigurationBuilder dockerFile(String dockerFile)
```
Path to a Dockerfile which also triggers Dockerfile mode. The Docker build context directory is set to contextDir if given. If not the directory by default is the directory in which the Dockerfile is stored.

Returns:

this.

dockerArchive
```
public BuildConfiguration.BuildConfigurationBuilder dockerArchive(String dockerArchive)
```
Path to a docker archive to load an image instead of building from scratch. If a dockerArchive is provided, no BuildConfiguration.dockerFile must be given.

Returns:

this.

filter
```
public BuildConfiguration.BuildConfigurationBuilder filter(String filter)
```
Enable and set the delimiters for property replacements.
By default properties in the format ${..} are replaced with Maven properties. When using a single char like @ then this is used as a delimiter (e.g @…@).

Returns:

this.

from
```
public BuildConfiguration.BuildConfigurationBuilder from(String from)
```
The base image which should be used for this image.
If not given this default to busybox:latest and is suitable for a pure data image.

Returns:

this.

fromExt
```
public BuildConfiguration.BuildConfigurationBuilder fromExt(Map<String,String> fromExt)
```
Extended definition for a base image. This field holds a map of defined in key:value format.
The known keys are:
- name: Name of the base image
A provided BuildConfiguration.from takes precedence over the name given here. This tag is useful for extensions of this plugin.
Returns:

this.

maintainer

public BuildConfiguration.BuildConfigurationBuilder maintainer(String maintainer)

The author (MAINTAINER) field for the generated image

Returns:: this.

port

public BuildConfiguration.BuildConfigurationBuilder port(String port)

ports

public BuildConfiguration.BuildConfigurationBuilder ports(Collection<? extends String> ports)

clearPorts

public BuildConfiguration.BuildConfigurationBuilder clearPorts()

shell
```
public BuildConfiguration.BuildConfigurationBuilder shell(Arguments shell)
```
Shell to be used for the BuildConfiguration.runCmds. It contains arg elements which are defining the executable and its params.

Returns:

this.

imagePullPolicy
```
public BuildConfiguration.BuildConfigurationBuilder imagePullPolicy(String imagePullPolicy)
```
Specific pull policy for the base image. This overrides any global image pull policy.

Returns:

this.

runCmd

public BuildConfiguration.BuildConfigurationBuilder runCmd(String runCmd)

runCmds

public BuildConfiguration.BuildConfigurationBuilder runCmds(Collection<? extends String> runCmds)

clearRunCmds

public BuildConfiguration.BuildConfigurationBuilder clearRunCmds()

cleanup
```
public BuildConfiguration.BuildConfigurationBuilder cleanup(String cleanup)
```
Cleanup dangling (untagged) images after each build (including any containers created from them)
- try: tries to remove the old image but doesn't fail the build if this is not possible
- remove: removes old image or fails if it doesn't
- none: No cleanup is requested
Returns:

this.

nocache

public BuildConfiguration.BuildConfigurationBuilder nocache(Boolean nocache)

Don't use Docker’s build cache.

Returns:: this.

optimise
```
public BuildConfiguration.BuildConfigurationBuilder optimise(Boolean optimise)
```
If set to true then it will compress all the BuildConfiguration.runCmds into a single RUN directive so that only one image layer is created.

Returns:

this.

volume

public BuildConfiguration.BuildConfigurationBuilder volume(String volume)

volumes

public BuildConfiguration.BuildConfigurationBuilder volumes(Collection<? extends String> volumes)

clearVolumes

public BuildConfiguration.BuildConfigurationBuilder clearVolumes()

tag

public BuildConfiguration.BuildConfigurationBuilder tag(String tag)

clearTags

public BuildConfiguration.BuildConfigurationBuilder clearTags()

putEnv

public BuildConfiguration.BuildConfigurationBuilder putEnv(String putEnvKey,
                                                           String putEnvValue)

env

public BuildConfiguration.BuildConfigurationBuilder env(Map<? extends String,? extends String> env)

clearEnv

public BuildConfiguration.BuildConfigurationBuilder clearEnv()

label

public BuildConfiguration.BuildConfigurationBuilder label(String labelKey,
                                                          String labelValue)

labels

public BuildConfiguration.BuildConfigurationBuilder labels(Map<? extends String,? extends String> labels)

clearLabels

public BuildConfiguration.BuildConfigurationBuilder clearLabels()

arg

public BuildConfiguration.BuildConfigurationBuilder arg(String argKey,
                                                        String argValue)

args

public BuildConfiguration.BuildConfigurationBuilder args(Map<? extends String,? extends String> args)

clearArgs

public BuildConfiguration.BuildConfigurationBuilder clearArgs()

entryPoint
```
public BuildConfiguration.BuildConfigurationBuilder entryPoint(Arguments entryPoint)
```
An entrypoint allows you to configure a container that will run as an executable.

Returns:

this.

workdir

public BuildConfiguration.BuildConfigurationBuilder workdir(String workdir)

Directory to change to when starting the container.

Returns:: this.

cmd

public BuildConfiguration.BuildConfigurationBuilder cmd(Arguments cmd)

A command to execute by default.

Returns:: this.

user
```
public BuildConfiguration.BuildConfigurationBuilder user(String user)
```
User to which the Dockerfile should switch to the end (corresponds to the USER Dockerfile directive).

Returns:

this.

healthCheck

public BuildConfiguration.BuildConfigurationBuilder healthCheck(HealthCheckConfiguration healthCheck)

Health check configuration.

Returns:: this.

assembly

public BuildConfiguration.BuildConfigurationBuilder assembly(AssemblyConfiguration assembly)

Specifies the assembly configuration.

Returns:: this.

skip

public BuildConfiguration.BuildConfigurationBuilder skip(Boolean skip)

If set to true disables building of the image.

Returns:: this.

compression
```
public BuildConfiguration.BuildConfigurationBuilder compression(ArchiveCompression compression)
```
The compression mode how the build archive is transmitted to the docker daemon and how docker build archives are attached to this build as sources.

Returns:

this.

buildOptions
```
public BuildConfiguration.BuildConfigurationBuilder buildOptions(Map<String,String> buildOptions)
```
Map specifying the build options to provide to the docker daemon when building the image.
These options map to the ones listed as query parameters in the Docker Remote API and are restricted to simple options (e.g.: memory, shmsize).

Returns:

this.

See Also:

Docker Engine API v1.40

dockerFileFile

public BuildConfiguration.BuildConfigurationBuilder dockerFileFile(File dockerFileFile)

Path to Dockerfile to use, initialized lazily.

Returns:: this.

dockerArchiveFile

public BuildConfiguration.BuildConfigurationBuilder dockerArchiveFile(File dockerArchiveFile)

addCacheFrom

public BuildConfiguration.BuildConfigurationBuilder addCacheFrom(String addCacheFrom)

cacheFrom

public BuildConfiguration.BuildConfigurationBuilder cacheFrom(Collection<? extends String> cacheFrom)

clearCacheFrom

public BuildConfiguration.BuildConfigurationBuilder clearCacheFrom()

build
```
public BuildConfiguration build()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class BuildConfiguration.BuildConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

compressionString

contextDir

dockerFile

dockerArchive

filter

from

fromExt