Value object representing the common rules for Docker and Kubernetes container names. Note that both container platforms have specific rules beyond these common rules.

ContainerPlatformType

enum ContainerPlatformType : Enum<ContainerPlatformType>

Enum class representing the container types supported by the library.

ContainerRuntime

interface ContainerRuntime

Interface representing the runtime of a container - either Docker or Kubernetes.

CPU

@JvmInline

value class CPU(val value: Double) : SimpleValueObject<Double>

Value object representing a kubernetes/docker cpu request or limit.

EnvVarKey

@JvmInline

value class EnvVarKey(val value: String) : SimpleValueObject<String>

Value object representing an environment variable key.

EnvVarValue

@JvmInline

value class EnvVarValue(val value: String) : SimpleValueObject<String>

Value object representing an environment variable value.

Executable

@JvmInline

value class Executable(val value: String) : SimpleValueObject<String>

Value object representing an executable, i.e. a command line with optional arguments.

ExecutionMode

enum ExecutionMode : Enum<ExecutionMode>

Enum class representing the execution mode of the container.

Host

@JvmInline

value class Host(val value: String) : SimpleValueObject<String>

Value object representing a host.

ImageName

@JvmInline

value class ImageName(val value: String) : SimpleValueObject<String>

Value object representing a Docker (registry) image name.

ImageTag

@JvmInline

value class ImageTag(val value: String) : SimpleValueObject<String>

Value object representing a Docker image tag.

ImageURL

data class ImageURL(val registryUrl: RegistryURL, val repositoryName: RepositoryName, val imageName: ImageName, val tag: ImageTag = ImageTag.LATEST)

Represents a Docker image URL consisting of a registry URL, repository name, image name, and tag.

LabelKey

@JvmInline

value class LabelKey(val value: String) : SimpleValueObject<String>

Value object representing a docker/kubernetes label key.

LabelValue

@JvmInline

value class LabelValue(val value: String) : SimpleValueObject<String>

Value object representing a docker/kubernetes label value.

Memory

@JvmInline

value class Memory(val bytes: BigInteger) : SimpleValueObject<BigInteger>

Value object representing kubernetes/docker memory.

Namespace

@JvmInline

value class Namespace(val value: String) : SimpleValueObject<String>

Value object representing a kubernetes namespace.

NetworkName

@JvmInline

value class NetworkName(val value: String) : SimpleValueObject<String>

Value object representing a Docker image tag.

NetworkPort

@JvmInline

value class NetworkPort(val value: Int) : SimpleValueObject<Int>

Value object representing a network port - range 1-65535.

PortMappingName

@JvmInline

value class PortMappingName(val value: String) : SimpleValueObject<String>

Value object representing a port mapping name

RegistryURL

@JvmInline

value class RegistryURL(val value: String) : SimpleValueObject<String>

Represents a URL of a registry.

RepositoryName

@JvmInline

value class RepositoryName(val value: String) : SimpleValueObject<String>

Represents a repository name in a software repository system.

SemanticVersion

@JvmInline

value class SemanticVersion(val value: String) : SimpleValueObject<String>

Value object representing a file name for a file to be added or mapped into a container.

UnixDir

@JvmInline

value class UnixDir(val value: String) : SimpleValueObject<String>

Represents a complete (starting with root '/') Unix directory path as a value object.

Verbosity

enum Verbosity : Enum<Verbosity>

Enum class representing different levels of verbosity.

Volume

data class Volume(val name: VolumeName, val mountDir: UnixDir, val hostDir: Path? = null, val memoryBacked: Boolean = false, val memory: Memory? = null)

Value object representing a volume to be added or mapped into a container.

VolumeName

@JvmInline

value class VolumeName(val value: String) : SimpleValueObject<String>

Represents a volume name.