RemoteImageBuild

data class RemoteImageBuild(val authConfigs: List<RemoteImageBuildAuthConfig>? = null, val buildArgs: Map<String, String>? = null, val buildId: String? = null, val buildLogFile: String? = null, val builder: String? = null, val cacheFroms: List<String>? = null, val cgroupParent: String? = null, val context: String, val cpuPeriod: Int? = null, val cpuQuota: Int? = null, val cpuSetCpus: String? = null, val cpuSetMems: String? = null, val cpuShares: Int? = null, val dockerfile: String? = null, val extraHosts: List<String>? = null, val forceRemove: Boolean? = null, val isolation: String? = null, val label: Map<String, String>? = null, val labels: Map<String, String>? = null, val memory: Int? = null, val memorySwap: Int? = null, val networkMode: String? = null, val noCache: Boolean? = null, val platform: String? = null, val pullParent: Boolean? = null, val remoteContext: String? = null, val remove: Boolean? = null, val secrets: List<RemoteImageBuildSecret>? = null, val securityOpts: List<String>? = null, val sessionId: String? = null, val shmSize: Int? = null, val squash: Boolean? = null, val suppressOutput: Boolean? = null, val tags: List<String>? = null, val target: String? = null, val ulimits: List<RemoteImageBuildUlimit>? = null, val version: String? = null)

Constructors

Link copied to clipboard
constructor(authConfigs: List<RemoteImageBuildAuthConfig>? = null, buildArgs: Map<String, String>? = null, buildId: String? = null, buildLogFile: String? = null, builder: String? = null, cacheFroms: List<String>? = null, cgroupParent: String? = null, context: String, cpuPeriod: Int? = null, cpuQuota: Int? = null, cpuSetCpus: String? = null, cpuSetMems: String? = null, cpuShares: Int? = null, dockerfile: String? = null, extraHosts: List<String>? = null, forceRemove: Boolean? = null, isolation: String? = null, label: Map<String, String>? = null, labels: Map<String, String>? = null, memory: Int? = null, memorySwap: Int? = null, networkMode: String? = null, noCache: Boolean? = null, platform: String? = null, pullParent: Boolean? = null, remoteContext: String? = null, remove: Boolean? = null, secrets: List<RemoteImageBuildSecret>? = null, securityOpts: List<String>? = null, sessionId: String? = null, shmSize: Int? = null, squash: Boolean? = null, suppressOutput: Boolean? = null, tags: List<String>? = null, target: String? = null, ulimits: List<RemoteImageBuildUlimit>? = null, version: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The configuration for the authentication

Link copied to clipboard
val buildArgs: Map<String, String>? = null

Pairs for build-time variables in the form of ENDPOINT : "https://example.com"

Link copied to clipboard
val builder: String? = null

Set the name of the buildx builder to use. If not set or empty, the legacy builder will be used.

Link copied to clipboard
val buildId: String? = null

BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request.

Link copied to clipboard
val buildLogFile: String? = null

Path to a file where the buildx log are written to. Only available when builder is set. If not set, no logs are available. The path is taken as is, so make sure to use a path that is available.

Link copied to clipboard
val cacheFroms: List<String>? = null

Images to consider as cache sources

Link copied to clipboard
val cgroupParent: String? = null

Optional parent cgroup for the container

Link copied to clipboard

Value to specify the build context. Currently, only a PATH context is supported. You can use the helper function '${path.cwd}/context-dir'. This always refers to the local working directory, even when building images on remote hosts. Please see https://docs.docker.com/build/building/context/ for more information about build contexts.

Link copied to clipboard
val cpuPeriod: Int? = null

The length of a CPU period in microseconds

Link copied to clipboard
val cpuQuota: Int? = null

Microseconds of CPU time that the container can get in a CPU period

Link copied to clipboard
val cpuSetCpus: String? = null

CPUs in which to allow execution (e.g., 0-3, 0, 1)

Link copied to clipboard
val cpuSetMems: String? = null

MEMs in which to allow execution (0-3, 0, 1)

Link copied to clipboard
val cpuShares: Int? = null

CPU shares (relative weight)

Link copied to clipboard
val dockerfile: String? = null

Name of the Dockerfile. Defaults to Dockerfile.

Link copied to clipboard
val extraHosts: List<String>? = null

A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form "hostname:IP"

Link copied to clipboard
val forceRemove: Boolean? = null

Always remove intermediate containers

Link copied to clipboard
val isolation: String? = null

Isolation represents the isolation technology of a container. The supported values are

Link copied to clipboard
val label: Map<String, String>? = null

Set metadata for an image

Link copied to clipboard
val labels: Map<String, String>? = null

User-defined key/value metadata

Link copied to clipboard
val memory: Int? = null

Set memory limit for build

Link copied to clipboard
val memorySwap: Int? = null

Total memory (memory + swap), -1 to enable unlimited swap

Link copied to clipboard
val networkMode: String? = null

Set the networking mode for the RUN instructions during build

Link copied to clipboard
val noCache: Boolean? = null

Do not use the cache when building the image

Link copied to clipboard
val platform: String? = null

Set platform if server is multi-platform capable

Link copied to clipboard
val pullParent: Boolean? = null

Attempt to pull the image even if an older image exists locally

Link copied to clipboard
val remoteContext: String? = null

A Git repository URI or HTTP/HTTPS context URI. Will be ignored if builder is set.

Link copied to clipboard
val remove: Boolean? = null

Remove intermediate containers after a successful build. Defaults to true.

Link copied to clipboard

Set build-time secrets. Only available when you use a buildx builder.

Link copied to clipboard
val securityOpts: List<String>? = null

The security options

Link copied to clipboard
val sessionId: String? = null

Set an ID for the build session

Link copied to clipboard
val shmSize: Int? = null

Size of /dev/shm in bytes. The size must be greater than 0

Link copied to clipboard
val squash: Boolean? = null

If true the new layers are squashed into a new image with a single new layer

Link copied to clipboard
val suppressOutput: Boolean? = null

Suppress the build output and print image ID on success

Link copied to clipboard
val tags: List<String>? = null

Name and optionally a tag in the 'name:tag' format

Link copied to clipboard
val target: String? = null

Set the target build stage to build

Link copied to clipboard

Configuration for ulimits

Link copied to clipboard
val version: String? = null

Version of the underlying builder to use