RunImageConfiguration (JKube Kit :: Config

java.lang.Object
- org.eclipse.jkube.kit.config.image.RunImageConfiguration

All Implemented Interfaces:: Serializable

public class RunImageConfiguration
extends Object
implements Serializable

Author:: roland
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RunImageConfiguration.RunImageConfigurationBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`RunImageConfiguration.RunImageConfigurationBuilder`

Field Summary

Fields
Modifier and Type Field and Description

static RunImageConfiguration DEFAULT

Fields
Modifier and Type	Field and Description
`static RunImageConfiguration`	`DEFAULT`

Constructor Summary

Constructors
Constructor and Description
`RunImageConfiguration()`
RunImageConfiguration(Map<String,String> env, Map<String,String> labels, String envPropertyFile, Arguments cmd, String domainname, List<String> dependsOn, Arguments entrypoint, String hostname, String user, String workingDir, Long shmSize, Long memory, Long memorySwap, String portPropertyFile, String net, NetworkConfig network, List<String> dns, List<String> dnsSearch, List<String> capAdd, List<String> capDrop, List<String> securityOpts, Boolean privileged, List<String> extraHosts, Long cpuShares, Long cpus, String cpuSet, List<String> ports, String containerNamePattern, String exposedPropertyKey, RunVolumeConfiguration volumes, List<String> links, WaitConfiguration wait, List<String> tmpfs, LogConfiguration log, RestartPolicy restartPolicy, List<UlimitConfig> ulimits, Boolean skip, String imagePullPolicy, Boolean readOnly, Boolean autoRemove)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RunImageConfiguration.RunImageConfigurationBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Boolean`	`getAutoRemove()` Automatically remove the container when it exists.
`List<String>`	`getCapAdd()`
`List<String>`	`getCapDrop()`
`Arguments`	`getCmd()` Command to execute in container.
`String`	`getContainerNamePattern()` A pattern to define the naming of the container where: %a for the "alias" mode %n for the image name %t for a timestamp %i for an increasing index of container names
`Long`	`getCpus()`
`String`	`getCpuSet()`
`Long`	`getCpuShares()`
`List<String>`	`getDependsOn()` Custom networks are available since API 1.21 (Docker 1.9).
`List<String>`	`getDns()`
`List<String>`	`getDnsSearch()`
`String`	`getDomainname()` Container domain name.
`Arguments`	`getEntrypoint()` Container entry point.
`Map<String,String>`	`getEnv()` Environment variables to set when starting the container.
`String`	`getEnvPropertyFile()` Path to a property file holding environment variables.
`String`	`getExposedPropertyKey()` Property key part used to expose the container ip when running.
`List<String>`	`getExtraHosts()`
`String`	`getHostname()` Container hostname.
`String`	`getImagePullPolicy()` Policy for pulling the image to start
`Map<String,String>`	`getLabels()`
`List<String>`	`getLinks()`
`LogConfiguration`	`getLog()`
`Long`	`getMemory()` Memory in bytes.
`Long`	`getMemorySwap()` Total memory (swap + ram) in bytes, -1 to disable.
`String`	`getNet()` For simple network setups.
`NetworkConfig`	`getNetwork()`
`NetworkConfig`	`getNetworkingConfig()`
`String`	`getPortPropertyFile()` Path to a file where the dynamically mapped properties are written to.
`List<String>`	`getPorts()`
`Boolean`	`getPrivileged()`
`Boolean`	`getReadOnly()` Mount the container's root filesystem as read only.
`RestartPolicy`	`getRestartPolicy()`
`List<String>`	`getSecurityOpts()`
`Long`	`getShmSize()` Size of /dev/shm in bytes.
`Boolean`	`getSkip()`
`List<String>`	`getTmpfs()` Mountpath for tmps.
`List<UlimitConfig>`	`getUlimits()`
`String`	`getUser()` Container user.
`RunVolumeConfiguration`	`getVolumeConfiguration()`
`RunVolumeConfiguration`	`getVolumes()` Mount volumes from the given image's started containers.
`WaitConfiguration`	`getWait()` Configuration for how to wait during startup of the container.
`String`	`getWorkingDir()` Working directory.
`int`	`hashCode()`
`String`	`initAndValidate()`
`boolean`	`isDefault()`
`boolean`	`skip()`
`RunImageConfiguration.RunImageConfigurationBuilder`	`toBuilder()`

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

Field Detail

DEFAULT

public static final RunImageConfiguration DEFAULT

Constructor Detail

RunImageConfiguration

public RunImageConfiguration(Map<String,String> env,
                             Map<String,String> labels,
                             String envPropertyFile,
                             Arguments cmd,
                             String domainname,
                             List<String> dependsOn,
                             Arguments entrypoint,
                             String hostname,
                             String user,
                             String workingDir,
                             Long shmSize,
                             Long memory,
                             Long memorySwap,
                             String portPropertyFile,
                             String net,
                             NetworkConfig network,
                             List<String> dns,
                             List<String> dnsSearch,
                             List<String> capAdd,
                             List<String> capDrop,
                             List<String> securityOpts,
                             Boolean privileged,
                             List<String> extraHosts,
                             Long cpuShares,
                             Long cpus,
                             String cpuSet,
                             List<String> ports,
                             String containerNamePattern,
                             String exposedPropertyKey,
                             RunVolumeConfiguration volumes,
                             List<String> links,
                             WaitConfiguration wait,
                             List<String> tmpfs,
                             LogConfiguration log,
                             RestartPolicy restartPolicy,
                             List<UlimitConfig> ulimits,
                             Boolean skip,
                             String imagePullPolicy,
                             Boolean readOnly,
                             Boolean autoRemove)

RunImageConfiguration
```
public RunImageConfiguration()
```

Method Detail

isDefault
```
public boolean isDefault()
```

initAndValidate
```
public String initAndValidate()
```

getDependsOn
```
@Nonnull
public List<String> getDependsOn()
```
Custom networks are available since API 1.21 (Docker 1.9).

getPorts

@Nonnull
public List<String> getPorts()

getNetworkingConfig

public NetworkConfig getNetworkingConfig()

getVolumeConfiguration

public RunVolumeConfiguration getVolumeConfiguration()

getLinks

@Nonnull
public List<String> getLinks()

getRestartPolicy

public RestartPolicy getRestartPolicy()

skip
```
public boolean skip()
```

builder

public static RunImageConfiguration.RunImageConfigurationBuilder builder()

toBuilder

public RunImageConfiguration.RunImageConfigurationBuilder toBuilder()

getEnv
```
public Map<String,String> getEnv()
```
Environment variables to set when starting the container. key: variable name, value: env value.

getLabels
```
public Map<String,String> getLabels()
```

getEnvPropertyFile
```
public String getEnvPropertyFile()
```
Path to a property file holding environment variables.

getCmd
```
public Arguments getCmd()
```
Command to execute in container.

getDomainname
```
public String getDomainname()
```
Container domain name.

getEntrypoint
```
public Arguments getEntrypoint()
```
Container entry point.

getHostname
```
public String getHostname()
```
Container hostname.

getUser
```
public String getUser()
```
Container user.

getWorkingDir
```
public String getWorkingDir()
```
Working directory.

getShmSize
```
public Long getShmSize()
```
Size of /dev/shm in bytes.

getMemory
```
public Long getMemory()
```
Memory in bytes.

getMemorySwap
```
public Long getMemorySwap()
```
Total memory (swap + ram) in bytes, -1 to disable.

getPortPropertyFile
```
public String getPortPropertyFile()
```
Path to a file where the dynamically mapped properties are written to.

getNet
```
public String getNet()
```
For simple network setups. For complex stuff use "network".

getNetwork
```
public NetworkConfig getNetwork()
```

getDns
```
public List<String> getDns()
```

getDnsSearch
```
public List<String> getDnsSearch()
```

getCapAdd
```
public List<String> getCapAdd()
```

getCapDrop
```
public List<String> getCapDrop()
```

getSecurityOpts
```
public List<String> getSecurityOpts()
```

getPrivileged
```
public Boolean getPrivileged()
```

getExtraHosts
```
public List<String> getExtraHosts()
```

getCpuShares
```
public Long getCpuShares()
```

getCpus
```
public Long getCpus()
```

getCpuSet
```
public String getCpuSet()
```

getContainerNamePattern
```
public String getContainerNamePattern()
```
A pattern to define the naming of the container where:
- %a for the "alias" mode
- %n for the image name
- %t for a timestamp
- %i for an increasing index of container names

getExposedPropertyKey
```
public String getExposedPropertyKey()
```
Property key part used to expose the container ip when running.

getVolumes
```
public RunVolumeConfiguration getVolumes()
```
Mount volumes from the given image's started containers.

getWait
```
public WaitConfiguration getWait()
```
Configuration for how to wait during startup of the container.

getTmpfs
```
public List<String> getTmpfs()
```
Mountpath for tmps.

getLog
```
public LogConfiguration getLog()
```

getUlimits

public List<UlimitConfig> getUlimits()

getSkip
```
public Boolean getSkip()
```

getImagePullPolicy
```
public String getImagePullPolicy()
```
Policy for pulling the image to start

getReadOnly
```
public Boolean getReadOnly()
```
Mount the container's root filesystem as read only.

getAutoRemove
```
public Boolean getAutoRemove()
```
Automatically remove the container when it exists.

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 RunImageConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

Constructor Detail

RunImageConfiguration

RunImageConfiguration

Method Detail

isDefault

initAndValidate

getDependsOn

getPorts

getNetworkingConfig

getVolumeConfiguration

getLinks

getRestartPolicy

skip

builder

toBuilder

getEnv

getLabels

getEnvPropertyFile

getCmd

getDomainname

getEntrypoint

getHostname

getUser

getWorkingDir

getShmSize

getMemory

getMemorySwap

getPortPropertyFile

getNet

getNetwork

getDns

getDnsSearch

getCapAdd

getCapDrop

getSecurityOpts

getPrivileged

getExtraHosts

getCpuShares

getCpus

getCpuSet

getContainerNamePattern

getExposedPropertyKey

getVolumes

getWait

getTmpfs

getLog

getUlimits

getSkip

getImagePullPolicy

getReadOnly

getAutoRemove

equals

canEqual

hashCode