BuildConfiguration (JKube Kit :: Config

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

All Implemented Interfaces:

Serializable
```
public class BuildConfiguration
extends Object
implements Serializable
```
Author:

roland

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BuildConfiguration.BuildConfigurationBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`BuildConfiguration.BuildConfigurationBuilder`

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_CLEANUP

static String DEFAULT_FILTER

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CLEANUP`
`static String`	`DEFAULT_FILTER`

Constructor Summary

Constructors
Constructor and Description
`BuildConfiguration()`
BuildConfiguration(String from, Map<String,String> fromExt, List<String> ports, String imagePullPolicy, List<String> volumes, List<String> tags, Map<String,String> env, Map<String,String> labels, String workdir, Arguments cmd, String user, Arguments entryPoint, AssemblyConfiguration assembly, Boolean skip, String contextDir, String dockerFile, String dockerArchive, String filter, String maintainer, Arguments shell, List<String> runCmds, String cleanup, Boolean nocache, Boolean optimise, Map<String,String> args, HealthCheckConfiguration healthCheck, ArchiveCompression compression, Map<String,String> buildOptions, Map<String,String> createImageOptions, File dockerFileFile, File dockerArchiveFile, List<String> cacheFrom)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BuildConfiguration.BuildConfigurationBuilder`	`builder()`
`File`	`calculateDockerFilePath()`
`protected boolean`	`canEqual(Object other)`
`CleanupMode`	`cleanupMode()`
`boolean`	`equals(Object o)`
`File`	`getAbsoluteContextDirPath(String sourceDirectory, String projectBaseDir)`
`File`	`getAbsoluteDockerFilePath(String sourceDirectory, String projectBaseDir)`
`File`	`getAbsoluteDockerTarPath(String sourceDirectory, String projectBaseDir)`
`Map<String,String>`	`getArgs()` Map specifying the value of Docker build args which should be used when building the image with an external Dockerfile which uses build arguments.
`AssemblyConfiguration`	`getAssembly()` Specifies the assembly configuration.
`Map<String,String>`	`getBuildOptions()` Map specifying the build options to provide to the docker daemon when building the image.
`List<String>`	`getCacheFrom()` Array of images used for build cache resolution.
`String`	`getCleanup()` 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
`Arguments`	`getCmd()` A command to execute by default.
`ArchiveCompression`	`getCompression()`
`File`	`getContextDir()`
`String`	`getContextDirRaw()`
`Map<String,String>`	`getCreateImageOptions()` Map specifying the create image options to provide to the docker daemon when pulling or importing an image.
`File`	`getDockerArchive()`
`File`	`getDockerArchiveFile()` Path to archive file passed to docker daemon.
`String`	`getDockerArchiveRaw()`
`File`	`getDockerFile()`
`File`	`getDockerFileFile()` Path to Dockerfile to use, initialized lazily.
`String`	`getDockerFileRaw()`
`Arguments`	`getEntryPoint()` An entrypoint allows you to configure a container that will run as an executable.
`Map<String,String>`	`getEnv()` Environment variables.
`String`	`getFilter()` Enable and set the delimiters for property replacements.
`String`	`getFrom()`
`Map<String,String>`	`getFromExt()` Extended definition for a base image.
`HealthCheckConfiguration`	`getHealthCheck()` Health check configuration.
`String`	`getImagePullPolicy()` Specific pull policy for the base image.
`Map<String,String>`	`getLabels()` Labels.
`String`	`getMaintainer()` The author (MAINTAINER) field for the generated image
`Boolean`	`getNocache()` Don't use Docker’s build cache.
`Boolean`	`getOptimise()` If set to true then it will compress all the `runCmds` into a single RUN directive so that only one image layer is created.
`List<String>`	`getPorts()`
`List<String>`	`getRunCmds()`
`Arguments`	`getShell()` Shell to be used for the `runCmds`.
`Boolean`	`getSkip()`
`List<String>`	`getTags()`
`String`	`getUser()` User to which the image should switch to the end (corresponds to the `USER` Dockerfile directive).
`List<String>`	`getVolumes()`
`String`	`getWorkdir()` Directory to change to when starting the container.
`int`	`hashCode()`
`String`	`initAndValidate()`
`boolean`	`isDockerFileMode()`
`boolean`	`nocache()`
`boolean`	`optimise()`
`BuildConfiguration.BuildConfigurationBuilder`	`toBuilder()`
`String`	`validate()`

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

Field Detail
- DEFAULT_FILTER
```
public static final String DEFAULT_FILTER
```
  See Also:
  
  Constant Field Values
- DEFAULT_CLEANUP
```
public static final String DEFAULT_CLEANUP
```
  See Also:
  
  Constant Field Values

Constructor Detail

BuildConfiguration

public BuildConfiguration(String from,
                          Map<String,String> fromExt,
                          List<String> ports,
                          String imagePullPolicy,
                          List<String> volumes,
                          List<String> tags,
                          Map<String,String> env,
                          Map<String,String> labels,
                          String workdir,
                          Arguments cmd,
                          String user,
                          Arguments entryPoint,
                          AssemblyConfiguration assembly,
                          Boolean skip,
                          String contextDir,
                          String dockerFile,
                          String dockerArchive,
                          String filter,
                          String maintainer,
                          Arguments shell,
                          List<String> runCmds,
                          String cleanup,
                          Boolean nocache,
                          Boolean optimise,
                          Map<String,String> args,
                          HealthCheckConfiguration healthCheck,
                          ArchiveCompression compression,
                          Map<String,String> buildOptions,
                          Map<String,String> createImageOptions,
                          File dockerFileFile,
                          File dockerArchiveFile,
                          List<String> cacheFrom)

BuildConfiguration
```
public BuildConfiguration()
```

Method Detail
- isDockerFileMode
```
public boolean isDockerFileMode()
```
- getDockerFile
```
public File getDockerFile()
```
- getDockerFileRaw
```
public String getDockerFileRaw()
```
- getDockerArchive
```
public File getDockerArchive()
```
- getDockerArchiveRaw
```
public String getDockerArchiveRaw()
```
- getContextDir
```
@Nonnull
public File getContextDir()
```
- getContextDirRaw
```
public String getContextDirRaw()
```
- getFrom
```
public String getFrom()
```
- getPorts
```
public List<String> getPorts()
```
- getVolumes
```
public List<String> getVolumes()
```
- getTags
```
public List<String> getTags()
```
- getSkip
```
public Boolean getSkip()
```
- getCompression
```
public ArchiveCompression getCompression()
```
- getRunCmds
```
public List<String> getRunCmds()
```
- optimise
```
public boolean optimise()
```
- nocache
```
public boolean nocache()
```
- cleanupMode
```
public CleanupMode cleanupMode()
```
- getAbsoluteContextDirPath
```
public File getAbsoluteContextDirPath(String sourceDirectory,
                                      String projectBaseDir)
```
- getAbsoluteDockerFilePath
```
public File getAbsoluteDockerFilePath(String sourceDirectory,
                                      String projectBaseDir)
```
- getAbsoluteDockerTarPath
```
public File getAbsoluteDockerTarPath(String sourceDirectory,
                                     String projectBaseDir)
```
- initAndValidate
```
public String initAndValidate()
```
- validate
```
public String validate()
```
- calculateDockerFilePath
```
@Nonnull
public File calculateDockerFilePath()
```
- builder
```
public static BuildConfiguration.BuildConfigurationBuilder builder()
```
- toBuilder
```
public BuildConfiguration.BuildConfigurationBuilder toBuilder()
```
- getFromExt
```
public Map<String,String> getFromExt()
```
  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 from takes precedence over the name given here. This tag is useful for extensions of this plugin.
  This field is applicable for all build strategies.
- getImagePullPolicy
```
public String getImagePullPolicy()
```
  Specific pull policy for the base image. This overrides any global image pull policy.
  This field is applicable for all build strategies.
- getEnv
```
public Map<String,String> getEnv()
```
  Environment variables.
  This field is applicable for all build strategies.
- getLabels
```
public Map<String,String> getLabels()
```
  Labels.
  This field is applicable for all build strategies.
- getWorkdir
```
public String getWorkdir()
```
  Directory to change to when starting the container.
  This field is applicable for all build strategies.
- getCmd
```
public Arguments getCmd()
```
  A command to execute by default.
  This field is applicable for all build strategies.
- getUser
```
public String getUser()
```
  User to which the image should switch to the end (corresponds to the USER Dockerfile directive).
  This field is applicable for all build strategies.
- getEntryPoint
```
public Arguments getEntryPoint()
```
  An entrypoint allows you to configure a container that will run as an executable.
  This field is applicable for all build strategies.
- getAssembly
```
public AssemblyConfiguration getAssembly()
```
  Specifies the assembly configuration.
  This field is applicable for all build strategies.
- getFilter
```
public String getFilter()
```
  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 @…@).
  This field is applicable only for docker build strategy
- getMaintainer
```
public String getMaintainer()
```
  The author (MAINTAINER) field for the generated image
  This field is applicable only for docker build strategy
- getShell
```
public Arguments getShell()
```
  Shell to be used for the runCmds. It contains arg elements which are defining the executable and its params.
  This field is applicable only for docker build strategy
- getCleanup
```
public String getCleanup()
```
  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
  This field is applicable only for docker build strategy
- getNocache
```
public Boolean getNocache()
```
  Don't use Docker’s build cache.
  This field is applicable only for docker build strategy
- getOptimise
```
public Boolean getOptimise()
```
  If set to true then it will compress all the runCmds into a single RUN directive so that only one image layer is created.
  This field is applicable only for docker build strategy
- getArgs
```
public Map<String,String> getArgs()
```
  Map specifying the value of Docker build args which should be used when building the image with an external Dockerfile which uses build arguments.
  The key-value syntax is the same as when defining Maven properties (or labels or env). This argument is ignored when no external Dockerfile is used.
  This field is applicable only for docker build strategy
- getHealthCheck
```
public HealthCheckConfiguration getHealthCheck()
```
  Health check configuration.
  This field is applicable only for docker build strategy
- getBuildOptions
```
public Map<String,String> getBuildOptions()
```
  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).
  
  See Also:
  
  Docker Engine API v1.40
  This field is applicable only for docker build strategy
- getCreateImageOptions
```
public Map<String,String> getCreateImageOptions()
```
  Map specifying the create image options to provide to the docker daemon when pulling or importing an image.
  These options map to the ones listed as query parameters in the Docker Remote API and are restricted to simple options (e.g.: fromImage, fromSrc, platform).
  
  See Also:
  
  Docker Engine API v1.41
  This field is applicable only for docker build strategy
- getDockerFileFile
```
public File getDockerFileFile()
```
  Path to Dockerfile to use, initialized lazily.
  This field is applicable only for docker build strategy
- getDockerArchiveFile
```
public File getDockerArchiveFile()
```
  Path to archive file passed to docker daemon.
  This field is applicable only for docker build strategy
- getCacheFrom
```
public List<String> getCacheFrom()
```
  Array of images used for build cache resolution.
  This field is applicable only for docker build strategy
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- canEqual
```
protected boolean canEqual(Object other)
```
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object

Class BuildConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FILTER

DEFAULT_CLEANUP

Constructor Detail

BuildConfiguration

BuildConfiguration

Method Detail

isDockerFileMode

getDockerFile

getDockerFileRaw

getDockerArchive

getDockerArchiveRaw

getContextDir

getContextDirRaw

getFrom

getPorts

getVolumes

getTags

getSkip

getCompression

getRunCmds

optimise

nocache

cleanupMode

getAbsoluteContextDirPath

getAbsoluteDockerFilePath

getAbsoluteDockerTarPath

initAndValidate

validate

calculateDockerFilePath

builder

toBuilder

getFromExt

getImagePullPolicy

getEnv

getLabels

getWorkdir

getCmd

getUser

getEntryPoint

getAssembly

getFilter

getMaintainer

getShell

getCleanup

getNocache

getOptimise

getArgs

getHealthCheck

getBuildOptions

getCreateImageOptions

getDockerFileFile

getDockerArchiveFile

getCacheFrom

equals

canEqual

hashCode