Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model

Package-level declarations

Types

@Serializable

data class Address(val addr: String? = null, val prefixLen: Int? = null)

Address represents an IPv4 or IPv6 IP address.

@Serializable

data class AuthConfig(val username: String, val password: String, val email: String? = null, val serveraddress: String? = null)

BuildCache

@Serializable

data class BuildCache(val ID: String? = null, val parent: String? = null, val parents: List<String>? = null, val type: BuildCache.Type? = null, val description: String? = null, val inUse: Boolean? = null, val shared: Boolean? = null, val propertySize: Int? = null, val createdAt: String? = null, val lastUsedAt: String? = null, val usageCount: Int? = null)

BuildCache contains information about a build cache record.

BuildInfo

@Serializable

data class BuildInfo(val id: String? = null, val stream: String? = null, val error: String? = null, val errorDetail: ErrorDetail? = null, val status: String? = null, val progress: String? = null, val progressDetail: ProgressDetail? = null, val aux: ImageID? = null)

BuildPruneResponse

@Serializable

data class BuildPruneResponse(val cachesDeleted: List<String>? = null, val spaceReclaimed: Long? = null)

ChangeType

@Serializable

enum ChangeType : Enum<ChangeType>

Kind of change Can be one of: - 0: Modified (\"C\") - 1: Added (\"A\") - 2: Deleted (\"D\")

ClusterInfo

@Serializable

data class ClusterInfo(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: SwarmSpec? = null, val tlSInfo: TLSInfo? = null, val rootRotationInProgress: Boolean? = null, val dataPathPort: Int? = null, val defaultAddrPool: List<String>? = null, val subnetSize: Int? = null)

ClusterInfo represents information about the swarm as is returned by the \"/info\" endpoint. Join-tokens are not included.

ClusterVolume

@Serializable

data class ClusterVolume(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: ClusterVolumeSpec? = null, val info: ClusterVolumeInfo? = null, val publishStatus: List<ClusterVolumePublishStatusInner>? = null)

Options and information specific to, and only present on, Swarm CSI cluster volumes.

ClusterVolumeInfo

@Serializable

data class ClusterVolumeInfo(val capacityBytes: Long? = null, val volumeContext: Map<String, String>? = null, val volumeID: String? = null, val accessibleTopology: List<Map<String, String>>? = null)

Information about the global status of the volume.

ClusterVolumePublishStatusInner

@Serializable

data class ClusterVolumePublishStatusInner(val nodeID: String? = null, val state: ClusterVolumePublishStatusInner.State? = null, val publishContext: Map<String, String>? = null)

ClusterVolumeSpec

@Serializable

data class ClusterVolumeSpec(val group: String? = null, val accessMode: ClusterVolumeSpecAccessMode? = null)

Cluster-specific options used to create the volume.

ClusterVolumeSpecAccessMode

@Serializable

data class ClusterVolumeSpecAccessMode(val scope: ClusterVolumeSpecAccessMode.Scope? = Scope.SINGLE, val sharing: ClusterVolumeSpecAccessMode.Sharing? = Sharing.NONE, val mountVolume: JsonObject? = null, val secrets: List<ClusterVolumeSpecAccessModeSecretsInner>? = null, val accessibilityRequirements: ClusterVolumeSpecAccessModeAccessibilityRequirements? = null, val capacityRange: ClusterVolumeSpecAccessModeCapacityRange? = null, val availability: ClusterVolumeSpecAccessMode.Availability? = Availability.ACTIVE)

Defines how the volume is used by tasks.

ClusterVolumeSpecAccessModeAccessibilityRequirements

@Serializable

data class ClusterVolumeSpecAccessModeAccessibilityRequirements(val requisite: List<Map<String, String>>? = null, val preferred: List<Map<String, String>>? = null)

Requirements for the accessible topology of the volume. These fields are optional. For an in-depth description of what these fields mean, see the CSI specification.

ClusterVolumeSpecAccessModeCapacityRange

@Serializable

data class ClusterVolumeSpecAccessModeCapacityRange(val requiredBytes: Long? = null, val limitBytes: Long? = null)

The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity.

ClusterVolumeSpecAccessModeSecretsInner

@Serializable

data class ClusterVolumeSpecAccessModeSecretsInner(val key: String? = null, val secret: String? = null)

One cluster volume secret entry. Defines a key-value pair that is passed to the plugin.

Commit

@Serializable

data class Commit(val ID: String? = null)

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

Config

@Serializable

data class Config(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: ConfigSpec? = null)

ConfigCreateRequest

@Serializable

data class ConfigCreateRequest(val name: String? = null, val labels: Map<String, String>? = null, val data: String? = null, val templating: Driver? = null)

ConfigReference

@Serializable

data class ConfigReference(val network: String? = null)

The config-only network source to provide the configuration for this network.

ConfigSpec

@Serializable

data class ConfigSpec(val name: String? = null, val labels: Map<String, String>? = null, val data: String? = null, val templating: Driver? = null)

ContainerBlkioStatEntry

@Serializable

data class ContainerBlkioStatEntry(val major: Int? = null, val minor: Int? = null, val op: String? = null, val value: Int? = null)

Blkio stats entry. This type is Linux-specific and omitted for Windows containers.

ContainerBlkioStats

@Serializable

data class ContainerBlkioStats(val ioServiceBytesRecursive: List<ContainerBlkioStatEntry>? = null, val ioServicedRecursive: List<ContainerBlkioStatEntry>? = null, val ioQueueRecursive: List<ContainerBlkioStatEntry>? = null, val ioServiceTimeRecursive: List<ContainerBlkioStatEntry>? = null, val ioWaitTimeRecursive: List<ContainerBlkioStatEntry>? = null, val ioMergedRecursive: List<ContainerBlkioStatEntry>? = null, val ioTimeRecursive: List<ContainerBlkioStatEntry>? = null, val sectorsRecursive: List<ContainerBlkioStatEntry>? = null)

BlkioStats stores all IO service stats for data read and write. This type is Linux-specific and holds many fields that are specific to cgroups v1. On a cgroup v2 host, all fields other than io_service_bytes_recursive are omitted or null. This type is only populated on Linux and omitted for Windows containers.

ContainerConfig

@Serializable

data class ContainerConfig(val hostname: String? = null, val domainname: String? = null, val user: String? = null, val attachStdin: Boolean? = false, val attachStdout: Boolean? = true, val attachStderr: Boolean? = true, val exposedPorts: Map<String, JsonObject>? = null, val tty: Boolean? = false, val openStdin: Boolean? = false, val stdinOnce: Boolean? = false, val env: List<String>? = null, val cmd: List<String>? = null, val healthcheck: HealthConfig? = null, val argsEscaped: Boolean? = false, val image: String? = null, val volumes: Map<String, JsonObject>? = null, val workingDir: String? = null, val entrypoint: List<String>? = null, val networkDisabled: Boolean? = null, val macAddress: String? = null, val onBuild: List<String>? = null, val labels: Map<String, String>? = null, val stopSignal: String? = null, val stopTimeout: Int? = null, val shell: List<String>? = null)

Configuration for a container that is portable between hosts.

ContainerCPUStats

@Serializable

data class ContainerCPUStats(val cpuUsage: ContainerCPUUsage? = null, val systemCpuUsage: Int? = null, val onlineCpus: Int? = null, val throttlingData: ContainerThrottlingData? = null)

CPU related info of the container

ContainerCPUUsage

@Serializable

data class ContainerCPUUsage(val totalUsage: Int? = null, val percpuUsage: List<Int>? = null, val usageInKernelmode: Int? = null, val usageInUsermode: Int? = null)

All CPU stats aggregated since container inception.

ContainerCreateRequest

@Serializable

data class ContainerCreateRequest(val hostname: String? = null, val domainname: String? = null, val user: String? = null, val attachStdin: Boolean? = false, val attachStdout: Boolean? = true, val attachStderr: Boolean? = true, val exposedPorts: Map<String, JsonObject>? = null, val tty: Boolean? = false, val openStdin: Boolean? = false, val stdinOnce: Boolean? = false, val env: List<String>? = null, val cmd: List<String>? = null, val healthcheck: HealthConfig? = null, val argsEscaped: Boolean? = false, val image: String? = null, val volumes: Map<String, JsonObject>? = null, val workingDir: String? = null, val entrypoint: List<String>? = null, val networkDisabled: Boolean? = null, val macAddress: String? = null, val onBuild: List<String>? = null, val labels: Map<String, String>? = null, val stopSignal: String? = null, val stopTimeout: Int? = null, val shell: List<String>? = null, val hostConfig: HostConfig? = null, val networkingConfig: NetworkingConfig? = null)

ContainerCreateResponse

@Serializable

data class ContainerCreateResponse(val id: String, val warnings: List<String>)

OK response to ContainerCreate operation

ContainerdInfo

@Serializable

data class ContainerdInfo(val address: String? = null, val namespaces: ContainerdInfoNamespaces? = null)

Information for connecting to the containerd instance that is used by the daemon. This is included for debugging purposes only.

ContainerdInfoNamespaces

@Serializable

data class ContainerdInfoNamespaces(val containers: String? = "moby", val plugins: String? = "plugins.moby")

The namespaces that the daemon uses for running containers and plugins in containerd. These namespaces can be configured in the daemon configuration, and are considered to be used exclusively by the daemon, Tampering with the containerd instance may cause unexpected behavior. As these namespaces are considered to be exclusively accessed by the daemon, it is not recommended to change these values, or to change them to a value that is used by other systems, such as cri-containerd.

ContainerInspectResponse

@Serializable

data class ContainerInspectResponse(val id: String? = null, val created: String? = null, val path: String? = null, val args: List<String>? = null, val state: ContainerState? = null, val image: String? = null, val resolvConfPath: String? = null, val hostnamePath: String? = null, val hostsPath: String? = null, val logPath: String? = null, val name: String? = null, val restartCount: Int? = null, val driver: String? = null, val platform: String? = null, val imageManifestDescriptor: OCIDescriptor? = null, val mountLabel: String? = null, val processLabel: String? = null, val appArmorProfile: String? = null, val execIDs: List<String>? = null, val hostConfig: HostConfig? = null, val graphDriver: DriverData? = null, val sizeRw: Long? = null, val sizeRootFs: Long? = null, val mounts: List<MountPoint>? = null, val config: ContainerConfig? = null, val networkSettings: NetworkSettings? = null)

ContainerLogsParameters

data class ContainerLogsParameters(val follow: Boolean = false, val stdout: Boolean = true, val stderr: Boolean = true, val timestamps: Boolean = false, val tail: String? = null, val since: Long? = null, val until: Long? = null)

ContainerMemoryStats

@Serializable

data class ContainerMemoryStats(val usage: Int? = null, val maxUsage: Int? = null, val stats: Map<String, Int>? = null, val failcnt: Int? = null, val limit: Int? = null, val commitbytes: Int? = null, val commitpeakbytes: Int? = null, val privateworkingset: Int? = null)

Aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only.

ContainerNetworkStats

@Serializable

data class ContainerNetworkStats(val rxBytes: Int? = null, val rxPackets: Int? = null, val rxErrors: Int? = null, val rxDropped: Int? = null, val txBytes: Int? = null, val txPackets: Int? = null, val txErrors: Int? = null, val txDropped: Int? = null, val endpointId: String? = null, val instanceId: String? = null)

Aggregates the network stats of one container

ContainerPidsStats

@Serializable

data class ContainerPidsStats(val current: Int? = null, val limit: Int? = null)

PidsStats contains Linux-specific stats of a container's process-IDs (PIDs). This type is Linux-specific and omitted for Windows containers.

ContainerPruneResponse

@Serializable

data class ContainerPruneResponse(val containersDeleted: List<String>? = null, val spaceReclaimed: Long? = null)

ContainerState

@Serializable

data class ContainerState(val status: ContainerState.Status? = null, val running: Boolean? = null, val paused: Boolean? = null, val restarting: Boolean? = null, val ooMKilled: Boolean? = null, val dead: Boolean? = null, val pid: Int? = null, val exitCode: Int? = null, val error: String? = null, val startedAt: String? = null, val finishedAt: String? = null, val health: Health? = null)

ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the \"inspect\" command.

ContainerStatsResponse

@Serializable

data class ContainerStatsResponse(val name: String? = null, val id: String? = null, val read: Instant? = null, val preread: Instant? = null, val pidsStats: ContainerPidsStats? = null, val blkioStats: ContainerBlkioStats? = null, val numProcs: Int? = null, val storageStats: ContainerStorageStats? = null, val cpuStats: ContainerCPUStats? = null, val precpuStats: ContainerCPUStats? = null, val memoryStats: ContainerMemoryStats? = null, val networks: JsonObject? = null)

Statistics sample for a container.

ContainerStatus

@Serializable

data class ContainerStatus(val containerID: String? = null, val PID: Int? = null, val exitCode: Int? = null)

represents the status of a container.

ContainerStorageStats

@Serializable

data class ContainerStorageStats(val readCountNormalized: Int? = null, val readSizeBytes: Int? = null, val writeCountNormalized: Int? = null, val writeSizeBytes: Int? = null)

StorageStats is the disk I/O stats for read/write on Windows. This type is Windows-specific and omitted for Linux containers.

ContainerSummary

@Serializable

data class ContainerSummary(val id: String? = null, val names: List<String>? = null, val image: String? = null, val imageID: String? = null, val imageManifestDescriptor: OCIDescriptor? = null, val command: String? = null, val created: Long? = null, val ports: List<Port>? = null, val sizeRw: Long? = null, val sizeRootFs: Long? = null, val labels: Map<String, String>? = null, val state: ContainerSummary.State? = null, val status: String? = null, val hostConfig: ContainerSummaryHostConfig? = null, val networkSettings: ContainerSummaryNetworkSettings? = null, val mounts: List<MountPoint>? = null)

ContainerSummaryHostConfig

@Serializable

data class ContainerSummaryHostConfig(val networkMode: String? = null, val annotations: Map<String, String>? = null)

Summary of host-specific runtime information of the container. This is a reduced set of information in the container's \"HostConfig\" as available in the container \"inspect\" response.

ContainerSummaryNetworkSettings

@Serializable

data class ContainerSummaryNetworkSettings(val networks: Map<String, EndpointSettings>? = null)

Summary of the container's network settings

ContainerThrottlingData

@Serializable

data class ContainerThrottlingData(val periods: Int? = null, val throttledPeriods: Int? = null, val throttledTime: Int? = null)

CPU throttling stats of the container. This type is Linux-specific and omitted for Windows containers.

ContainerTopResponse

@Serializable

data class ContainerTopResponse(val titles: List<String>? = null, val processes: List<List<String>>? = null)

Container \"top\" response.

ContainerUpdateRequest

@Serializable

data class ContainerUpdateRequest(val cpuShares: Int? = null, val memory: Long? = 0, val cgroupParent: String? = null, val blkioWeight: Int? = null, val blkioWeightDevice: List<ResourcesBlkioWeightDeviceInner>? = null, val blkioDeviceReadBps: List<ThrottleDevice>? = null, val blkioDeviceWriteBps: List<ThrottleDevice>? = null, val blkioDeviceReadIOps: List<ThrottleDevice>? = null, val blkioDeviceWriteIOps: List<ThrottleDevice>? = null, val cpuPeriod: Long? = null, val cpuQuota: Long? = null, val cpuRealtimePeriod: Long? = null, val cpuRealtimeRuntime: Long? = null, val cpusetCpus: String? = null, val cpusetMems: String? = null, val devices: List<DeviceMapping>? = null, val deviceCgroupRules: List<String>? = null, val deviceRequests: List<DeviceRequest>? = null, val kernelMemoryTCP: Long? = null, val memoryReservation: Long? = null, val memorySwap: Long? = null, val memorySwappiness: Long? = null, val nanoCpus: Long? = null, val oomKillDisable: Boolean? = null, val init: Boolean? = null, val pidsLimit: Long? = null, val ulimits: List<ResourcesUlimitsInner>? = null, val cpuCount: Long? = null, val cpuPercent: Long? = null, val ioMaximumIOps: Long? = null, val ioMaximumBandwidth: Long? = null, val restartPolicy: RestartPolicy? = null)

ContainerUpdateResponse

@Serializable

data class ContainerUpdateResponse(val warnings: List<String>? = null)

Response for a successful container-update.

ContainerWaitExitError

@Serializable

data class ContainerWaitExitError(val message: String? = null)

container waiting error, if any

ContainerWaitResponse

@Serializable

data class ContainerWaitResponse(val statusCode: Long, val error: ContainerWaitExitError? = null)

OK response to ContainerWait operation

CreateImageInfo

@Serializable

data class CreateImageInfo(val id: String? = null, val error: String? = null, val errorDetail: ErrorDetail? = null, val status: String? = null, val progress: String? = null, val progressDetail: ProgressDetail? = null)

DeviceInfo

@Serializable

data class DeviceInfo(val source: String? = null, val ID: String? = null)

DeviceInfo represents a device that can be used by a container.

DeviceMapping

@Serializable

data class DeviceMapping(val pathOnHost: String? = null, val pathInContainer: String? = null, val cgroupPermissions: String? = null)

A device mapping between the host and container

DeviceRequest

@Serializable

data class DeviceRequest(val driver: String? = null, val count: Int? = null, val deviceIDs: List<String>? = null, val capabilities: List<List<String>>? = null, val options: Map<String, String>? = null)

A request for devices to be sent to device drivers

DistributionInspect

@Serializable

data class DistributionInspect(val descriptor: OCIDescriptor, val platforms: List<OCIPlatform>)

Describes the result obtained from contacting the registry to retrieve image metadata.

Driver

@Serializable

data class Driver(val name: String, val options: Map<String, String>? = null)

Driver represents a driver (network, logging, secrets).

DriverData

@Serializable

data class DriverData(val name: String, val data: Map<String, String>)

Information about the storage driver used to store the container's and image's filesystem.

EndpointIPAMConfig

@Serializable

data class EndpointIPAMConfig(val ipv4Address: String? = null, val ipv6Address: String? = null, val linkLocalIPs: List<String>? = null)

EndpointIPAMConfig represents an endpoint's IPAM configuration.

EndpointPortConfig

@Serializable

data class EndpointPortConfig(val name: String? = null, val protocol: EndpointPortConfig.Protocol? = null, val targetPort: Int? = null, val publishedPort: Int? = null, val publishMode: EndpointPortConfig.PublishMode? = PublishMode.INGRESS)

EndpointSettings

@Serializable

data class EndpointSettings(val ipAMConfig: EndpointIPAMConfig? = null, val links: List<String>? = null, val macAddress: String? = null, val aliases: List<String>? = null, val driverOpts: Map<String, String>? = null, val gwPriority: Double? = null, val networkID: String? = null, val endpointID: String? = null, val gateway: String? = null, val ipAddress: String? = null, val ipPrefixLen: Int? = null, val ipv6Gateway: String? = null, val globalIPv6Address: String? = null, val globalIPv6PrefixLen: Long? = null, val dnSNames: List<String>? = null)

Configuration for a network endpoint.

EndpointSpec

@Serializable

data class EndpointSpec(val mode: EndpointSpec.Mode? = Mode.VIP, val ports: List<EndpointPortConfig>? = null)

Properties that can be configured to access and load balance a service.

EngineDescription

@Serializable

data class EngineDescription(val engineVersion: String? = null, val labels: Map<String, String>? = null, val plugins: List<EngineDescriptionPluginsInner>? = null)

EngineDescription provides information about an engine.

EngineDescriptionPluginsInner

@Serializable

data class EngineDescriptionPluginsInner(val type: String? = null, val name: String? = null)

ErrorDetail

@Serializable

data class ErrorDetail(val code: Int? = null, val message: String? = null)

ErrorResponse

@Serializable

data class ErrorResponse(val message: String)

Represents an error.

EventActor

@Serializable

data class EventActor(val ID: String? = null, val attributes: Map<String, String>? = null)

Actor describes something that generates events, like a container, network, or a volume.

EventMessage

@Serializable

data class EventMessage(val type: EventMessage.Type? = null, val action: String? = null, val actor: EventActor? = null, val scope: EventMessage.Scope? = null, val time: Long? = null, val timeNano: Long? = null)

EventMessage represents the information an event contains.

ExecConfig

@Serializable

data class ExecConfig(val attachStdin: Boolean? = null, val attachStdout: Boolean? = null, val attachStderr: Boolean? = null, val consoleSize: List<Int>? = null, val detachKeys: String? = null, val tty: Boolean? = null, val env: List<String>? = null, val cmd: List<String>? = null, val privileged: Boolean? = false, val user: String? = null, val workingDir: String? = null)

ExecInspectResponse

@Serializable

data class ExecInspectResponse(val canRemove: Boolean? = null, val detachKeys: String? = null, val ID: String? = null, val running: Boolean? = null, val exitCode: Int? = null, val processConfig: ProcessConfig? = null, val openStdin: Boolean? = null, val openStderr: Boolean? = null, val openStdout: Boolean? = null, val containerID: String? = null, val pid: Int? = null)

ExecSession

class ExecSession(incomingFlow: Flow<LogLine>, val isTty: Boolean, val connection: DockerRawConnection) : AutoCloseable

ExecStartConfig

@Serializable

data class ExecStartConfig(val detach: Boolean? = null, val tty: Boolean? = null, val consoleSize: List<Int>? = null)

FilesystemChange

@Serializable

data class FilesystemChange(val path: String, val kind: ChangeType)

Change in the container's filesystem.

FirewallInfo

@Serializable

data class FirewallInfo(val driver: String? = null, val info: List<List<String>>? = null)

Information about the daemon's firewalling configuration. This field is currently only used on Linux, and omitted on other platforms.

GenericResourcesInner

@Serializable

data class GenericResourcesInner(val namedResourceSpec: GenericResourcesInnerNamedResourceSpec? = null, val discreteResourceSpec: GenericResourcesInnerDiscreteResourceSpec? = null)

GenericResourcesInnerDiscreteResourceSpec

@Serializable

data class GenericResourcesInnerDiscreteResourceSpec(val kind: String? = null, val value: Long? = null)

GenericResourcesInnerNamedResourceSpec

@Serializable

data class GenericResourcesInnerNamedResourceSpec(val kind: String? = null, val value: String? = null)

Health

@Serializable

data class Health(val status: Health.Status? = null, val failingStreak: Int? = null, val log: List<HealthcheckResult>? = null)

Health stores information about the container's healthcheck results.

HealthcheckResult

@Serializable

data class HealthcheckResult(val start: Instant? = null, val end: String? = null, val exitCode: Int? = null, val output: String? = null)

HealthcheckResult stores information about a single run of a healthcheck probe

HealthConfig

@Serializable

data class HealthConfig(val test: List<String>? = null, val interval: Long? = null, val timeout: Long? = null, val retries: Int? = null, val startPeriod: Long? = null, val startInterval: Long? = null)

A test to perform to check that the container is healthy.

HistoryResponseItem

@Serializable

data class HistoryResponseItem(val id: String, val created: Long, val createdBy: String, val tags: List<String>, val propertySize: Long, val comment: String)

individual image layer information in response to ImageHistory operation

HostConfig

@Serializable

data class HostConfig(val cpuShares: Int? = null, val memory: Long? = 0, val cgroupParent: String? = null, val blkioWeight: Int? = null, val blkioWeightDevice: List<ResourcesBlkioWeightDeviceInner>? = null, val blkioDeviceReadBps: List<ThrottleDevice>? = null, val blkioDeviceWriteBps: List<ThrottleDevice>? = null, val blkioDeviceReadIOps: List<ThrottleDevice>? = null, val blkioDeviceWriteIOps: List<ThrottleDevice>? = null, val cpuPeriod: Long? = null, val cpuQuota: Long? = null, val cpuRealtimePeriod: Long? = null, val cpuRealtimeRuntime: Long? = null, val cpusetCpus: String? = null, val cpusetMems: String? = null, val devices: List<DeviceMapping>? = null, val deviceCgroupRules: List<String>? = null, val deviceRequests: List<DeviceRequest>? = null, val kernelMemoryTCP: Long? = null, val memoryReservation: Long? = null, val memorySwap: Long? = null, val memorySwappiness: Long? = null, val nanoCpus: Long? = null, val oomKillDisable: Boolean? = null, val init: Boolean? = null, val pidsLimit: Long? = null, val ulimits: List<ResourcesUlimitsInner>? = null, val cpuCount: Long? = null, val cpuPercent: Long? = null, val ioMaximumIOps: Long? = null, val ioMaximumBandwidth: Long? = null, val binds: List<String>? = null, val containerIDFile: String? = null, val logConfig: HostConfigAllOfLogConfig? = null, val networkMode: String? = null, val portBindings: Map<String, List<PortBinding>?>? = null, val restartPolicy: RestartPolicy? = null, val autoRemove: Boolean? = null, val volumeDriver: String? = null, val volumesFrom: List<String>? = null, val mounts: List<Mount>? = null, val consoleSize: List<Int>? = null, val annotations: Map<String, String>? = null, val capAdd: List<String>? = null, val capDrop: List<String>? = null, val cgroupnsMode: HostConfig.CgroupnsMode? = null, val dns: List<String>? = null, val dnsOptions: List<String>? = null, val dnsSearch: List<String>? = null, val extraHosts: List<String>? = null, val groupAdd: List<String>? = null, val ipcMode: String? = null, val cgroup: String? = null, val links: List<String>? = null, val oomScoreAdj: Int? = null, val pidMode: String? = null, val privileged: Boolean? = null, val publishAllPorts: Boolean? = null, val readonlyRootfs: Boolean? = null, val securityOpt: List<String>? = null, val storageOpt: Map<String, String>? = null, val tmpfs: Map<String, String>? = null, val utSMode: String? = null, val usernsMode: String? = null, val shmSize: Long? = null, val sysctls: Map<String, String>? = null, val runtime: String? = null, val isolation: HostConfig.Isolation? = null, val maskedPaths: List<String>? = null, val readonlyPaths: List<String>? = null)

Container configuration that depends on the host we are running on

HostConfigAllOfLogConfig

@Serializable

data class HostConfigAllOfLogConfig(val type: HostConfigAllOfLogConfig.Type? = null, val config: Map<String, String>? = null)

The logging configuration for this container

IDResponse

@Serializable

data class IDResponse(val id: String)

Response to an API call that returns just an Id

ImageConfig

@Serializable

data class ImageConfig(val user: String? = null, val exposedPorts: Map<String, JsonObject>? = null, val env: List<String>? = null, val cmd: List<String>? = null, val healthcheck: HealthConfig? = null, val argsEscaped: Boolean? = false, val volumes: Map<String, JsonObject>? = null, val workingDir: String? = null, val entrypoint: List<String>? = null, val onBuild: List<String>? = null, val labels: Map<String, String>? = null, val stopSignal: String? = null, val shell: List<String>? = null)

Configuration of the image. These fields are used as defaults when starting a container from the image.

ImageDeleteResponseItem

@Serializable

data class ImageDeleteResponseItem(val untagged: String? = null, val deleted: String? = null)

ImageID

@Serializable

data class ImageID(val ID: String? = null)

Image ID or Digest

ImageInspect

@Serializable

data class ImageInspect(val id: String? = null, val descriptor: OCIDescriptor? = null, val manifests: List<ImageManifestSummary>? = null, val repoTags: List<String>? = null, val repoDigests: List<String>? = null, val parent: String? = null, val comment: String? = null, val created: String? = null, val dockerVersion: String? = null, val author: String? = null, val config: ImageConfig? = null, val architecture: String? = null, val variant: String? = null, val os: String? = null, val osVersion: String? = null, val propertySize: Long? = null, val virtualSize: Long? = null, val graphDriver: DriverData? = null, val rootFS: ImageInspectRootFS? = null, val metadata: ImageInspectMetadata? = null)

Information about an image in the local image cache.

ImageInspectMetadata

@Serializable

data class ImageInspectMetadata(val lastTagTime: String? = null)

Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.

ImageInspectRootFS

@Serializable

data class ImageInspectRootFS(val type: String, val layers: List<String>? = null)

Information about the image's RootFS, including the layer IDs.

ImageManifestSummary

@Serializable

data class ImageManifestSummary(val ID: String, val descriptor: OCIDescriptor, val available: Boolean, val propertySize: ImageManifestSummarySize, val kind: ImageManifestSummary.Kind, val imageData: ImageManifestSummaryImageData? = null, val attestationData: ImageManifestSummaryAttestationData? = null)

ImageManifestSummary represents a summary of an image manifest.

ImageManifestSummaryAttestationData

@Serializable

data class ImageManifestSummaryAttestationData(val for: String)

The image data for the attestation manifest. This field is only populated when Kind is \"attestation\".

ImageManifestSummaryImageData

@Serializable

data class ImageManifestSummaryImageData(val platform: OCIPlatform?, val containers: List<String>, val propertySize: ImageManifestSummaryImageDataSize)

The image data for the image manifest. This field is only populated when Kind is \"image\".

ImageManifestSummaryImageDataSize

@Serializable

data class ImageManifestSummaryImageDataSize(val unpacked: Long)

ImageManifestSummarySize

@Serializable

data class ImageManifestSummarySize(val total: Long, val content: Long)

ImagePruneResponse

@Serializable

data class ImagePruneResponse(val imagesDeleted: List<ImageDeleteResponseItem>? = null, val spaceReclaimed: Long? = null)

ImageSearchResponseItem

@Serializable

data class ImageSearchResponseItem(val description: String? = null, val isOfficial: Boolean? = null, val isAutomated: Boolean? = null, val name: String? = null, val starCount: Int? = null)

ImageSummary

@Serializable

data class ImageSummary(val id: String, val parentId: String, val created: Int, val propertySize: Long, val sharedSize: Long, val labels: Map<String, String>?, val containers: Int, val repoTags: List<String>? = null, val repoDigests: List<String>? = null, val virtualSize: Long? = null, val manifests: List<ImageManifestSummary>? = null, val descriptor: OCIDescriptor? = null)

IndexInfo

@Serializable

data class IndexInfo(val name: String? = null, val mirrors: List<String>? = null, val secure: Boolean? = null, val official: Boolean? = null)

IndexInfo contains information about a registry.

IPAM

@Serializable

data class IPAM(val driver: String? = "default", val config: List<IPAMConfig>? = null, val options: Map<String, String>? = null)

IPAMConfig

@Serializable

data class IPAMConfig(val subnet: String? = null, val ipRange: String? = null, val gateway: String? = null, val auxiliaryAddresses: Map<String, String>? = null)

JoinTokens

@Serializable

data class JoinTokens(val worker: String? = null, val manager: String? = null)

JoinTokens contains the tokens workers and managers need to join the swarm.

Limit

@Serializable

data class Limit(val nanoCPUs: Long? = null, val memoryBytes: Long? = null, val pids: Long? = 0)

An object describing a limit on resources which can be requested by a task.

LocalNodeState

@Serializable

enum LocalNodeState : Enum<LocalNodeState>

Current local status of this node.

LogLine

data class LogLine(val type: LogLine.Type, val line: String)

ManagerStatus

@Serializable

data class ManagerStatus(val leader: Boolean? = false, val reachability: Reachability? = null, val addr: String? = null)

ManagerStatus represents the status of a manager. It provides the current status of a node's manager component, if the node is a manager.

Mount

@Serializable

data class Mount(val target: String? = null, val source: String? = null, val type: Mount.Type? = null, val readOnly: Boolean? = null, val consistency: String? = null, val bindOptions: MountBindOptions? = null, val volumeOptions: MountVolumeOptions? = null, val imageOptions: MountImageOptions? = null, val tmpfsOptions: MountTmpfsOptions? = null)

MountBindOptions

@Serializable

data class MountBindOptions(val propagation: MountBindOptions.Propagation? = null, val nonRecursive: Boolean? = false, val createMountpoint: Boolean? = false, val readOnlyNonRecursive: Boolean? = false, val readOnlyForceRecursive: Boolean? = false)

Optional configuration for the bind type.

MountImageOptions

@Serializable

data class MountImageOptions(val subpath: String? = null)

Optional configuration for the image type.

MountPoint

@Serializable

data class MountPoint(val type: MountPoint.Type? = null, val name: String? = null, val source: String? = null, val destination: String? = null, val driver: String? = null, val mode: String? = null, val RW: Boolean? = null, val propagation: String? = null)

MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.

MountTmpfsOptions

@Serializable

data class MountTmpfsOptions(val sizeBytes: Long? = null, val mode: Int? = null, val options: List<List<String>>? = null)

Optional configuration for the tmpfs type.

MountVolumeOptions

@Serializable

data class MountVolumeOptions(val noCopy: Boolean? = false, val labels: Map<String, String>? = null, val driverConfig: MountVolumeOptionsDriverConfig? = null, val subpath: String? = null)

Optional configuration for the volume type.

MountVolumeOptionsDriverConfig

@Serializable

data class MountVolumeOptionsDriverConfig(val name: String? = null, val options: Map<String, String>? = null)

Map of driver specific options

Network

@Serializable

data class Network(val name: String? = null, val id: String? = null, val created: String? = null, val scope: String? = null, val driver: String? = null, val enableIPv4: Boolean? = null, val enableIPv6: Boolean? = null, val IPAM: IPAM? = null, val internal: Boolean? = false, val attachable: Boolean? = false, val ingress: Boolean? = false, val configFrom: ConfigReference? = null, val configOnly: Boolean? = false, val containers: Map<String, NetworkContainer>? = null, val options: Map<String, String>? = null, val labels: Map<String, String>? = null, val peers: List<PeerInfo>? = null)

NetworkAttachmentConfig

@Serializable

data class NetworkAttachmentConfig(val target: String? = null, val aliases: List<String>? = null, val driverOpts: Map<String, String>? = null)

Specifies how a service should be attached to a particular network.

NetworkConnectRequest

@Serializable

data class NetworkConnectRequest(val container: String? = null, val endpointConfig: EndpointSettings? = null)

NetworkContainer

@Serializable

data class NetworkContainer(val name: String? = null, val endpointID: String? = null, val macAddress: String? = null, val ipv4Address: String? = null, val ipv6Address: String? = null)

NetworkCreateRequest

@Serializable

data class NetworkCreateRequest(val name: String, val driver: String? = "bridge", val scope: String? = null, val internal: Boolean? = null, val attachable: Boolean? = null, val ingress: Boolean? = null, val configOnly: Boolean? = false, val configFrom: ConfigReference? = null, val IPAM: IPAM? = null, val enableIPv4: Boolean? = null, val enableIPv6: Boolean? = null, val options: Map<String, String>? = null, val labels: Map<String, String>? = null)

NetworkCreateResponse

@Serializable

data class NetworkCreateResponse(val id: String, val warning: String)

OK response to NetworkCreate operation

NetworkDisconnectRequest

@Serializable

data class NetworkDisconnectRequest(val container: String? = null, val force: Boolean? = null)

NetworkingConfig

@Serializable

data class NetworkingConfig(val endpointsConfig: Map<String, EndpointSettings>? = null)

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

NetworkPruneResponse

@Serializable

data class NetworkPruneResponse(val networksDeleted: List<String>? = null)

NetworkSettings

@Serializable

data class NetworkSettings(val bridge: String? = null, val sandboxID: String? = null, val hairpinMode: Boolean? = null, val linkLocalIPv6Address: String? = null, val linkLocalIPv6PrefixLen: Int? = null, val ports: Map<String, List<PortBinding>?>? = null, val sandboxKey: String? = null, val secondaryIPAddresses: List<Address>? = null, val secondaryIPv6Addresses: List<Address>? = null, val endpointID: String? = null, val gateway: String? = null, val globalIPv6Address: String? = null, val globalIPv6PrefixLen: Int? = null, val ipAddress: String? = null, val ipPrefixLen: Int? = null, val ipv6Gateway: String? = null, val macAddress: String? = null, val networks: Map<String, EndpointSettings>? = null)

NetworkSettings exposes the network settings in the API

Node

@Serializable

data class Node(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: NodeSpec? = null, val description: NodeDescription? = null, val status: NodeStatus? = null, val managerStatus: ManagerStatus? = null)

NodeDescription

@Serializable

data class NodeDescription(val hostname: String? = null, val platform: Platform? = null, val resources: ResourceObject? = null, val engine: EngineDescription? = null, val tlSInfo: TLSInfo? = null)

NodeDescription encapsulates the properties of the Node as reported by the agent.

NodeSpec

@Serializable

data class NodeSpec(val name: String? = null, val labels: Map<String, String>? = null, val role: NodeSpec.Role? = null, val availability: NodeSpec.Availability? = null)

NodeState

@Serializable

enum NodeState : Enum<NodeState>

NodeState represents the state of a node.

NodeStatus

@Serializable

data class NodeStatus(val state: NodeState? = null, val message: String? = null, val addr: String? = null)

NodeStatus represents the status of a node. It provides the current status of the node, as seen by the manager.

ObjectVersion

@Serializable

data class ObjectVersion(val index: Int? = null)

The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects. This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.

OCIDescriptor

@Serializable

data class OCIDescriptor(val mediaType: String? = null, val digest: String? = null, val propertySize: Long? = null, val urls: List<String>? = null, val annotations: Map<String, String>? = null, val data: String? = null, val platform: OCIPlatform? = null, val artifactType: String? = null)

A descriptor struct containing digest, media type, and size, as defined in the OCI Content Descriptors Specification.

OCIPlatform

@Serializable

data class OCIPlatform(val architecture: String? = null, val os: String? = null, val osVersion: String? = null, val osFeatures: List<String>? = null, val variant: String? = null)

Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

PeerInfo

@Serializable

data class PeerInfo(val name: String? = null, val IP: String? = null)

PeerInfo represents one peer of an overlay network.

PeerNode

@Serializable

data class PeerNode(val nodeID: String? = null, val addr: String? = null)

Represents a peer-node in the swarm

Platform

@Serializable

data class Platform(val architecture: String? = null, val OS: String? = null)

Platform represents the platform (Arch/OS).

Plugin

@Serializable

data class Plugin(val name: String, val enabled: Boolean, val settings: PluginSettings, val config: PluginConfig, val id: String? = null, val pluginReference: String? = null)

A plugin for the Engine API

PluginConfig

@Serializable

data class PluginConfig(val description: String, val documentation: String, val interface: PluginConfigInterface, val entrypoint: List<String>, val workDir: String, val network: PluginConfigNetwork, val linux: PluginConfigLinux, val propagatedMount: String, val ipcHost: Boolean, val pidHost: Boolean, val mounts: List<PluginMount>, val env: List<PluginEnv>, val args: PluginConfigArgs, val dockerVersion: String? = null, val user: PluginConfigUser? = null, val rootfs: PluginConfigRootfs? = null)

The config of a plugin.

PluginConfigArgs

@Serializable

data class PluginConfigArgs(val name: String, val description: String, val settable: List<String>, val value: List<String>)

PluginConfigInterface

@Serializable

data class PluginConfigInterface(val types: List<PluginInterfaceType>, val socket: String, val protocolScheme: PluginConfigInterface.ProtocolScheme? = null)

The interface between Docker and the plugin

PluginConfigLinux

@Serializable

data class PluginConfigLinux(val capabilities: List<String>, val allowAllDevices: Boolean, val devices: List<PluginDevice>)

PluginConfigNetwork

@Serializable

data class PluginConfigNetwork(val type: String)

PluginConfigRootfs

@Serializable

data class PluginConfigRootfs(val type: String? = null, val diffIds: List<String>? = null)

PluginConfigUser

@Serializable

data class PluginConfigUser(val UID: Int? = null, val GID: Int? = null)

PluginDevice

@Serializable

data class PluginDevice(val name: String, val description: String, val settable: List<String>, val path: String)

PluginEnv

@Serializable

data class PluginEnv(val name: String, val description: String, val settable: List<String>, val value: String)

PluginInterfaceType

@Serializable

data class PluginInterfaceType(val prefix: String, val capability: String, val version: String)

PluginMount

@Serializable

data class PluginMount(val name: String, val description: String, val settable: List<String>, val source: String, val destination: String, val type: String, val options: List<String>)

PluginPrivilege

@Serializable

data class PluginPrivilege(val name: String? = null, val description: String? = null, val value: List<String>? = null)

Describes a permission the user has to accept upon installing the plugin.

PluginSettings

@Serializable

data class PluginSettings(val mounts: List<PluginMount>, val env: List<String>, val args: List<String>, val devices: List<PluginDevice>)

Settings that can be modified by users.

PluginsInfo

@Serializable

data class PluginsInfo(val volume: List<String>? = null, val network: List<String>? = null, val authorization: List<String>? = null, val log: List<String>? = null)

Available plugins per type.

>Note: Only unmanaged (V1) plugins are included in this list. > V1 plugins are \"lazily\" loaded, and are not returned in this list > if there is no resource using the plugin.

Port

@Serializable

data class Port(val privatePort: Int, val type: Port.Type, val IP: String? = null, val publicPort: Int? = null)

An open port on a container

PortBinding

@Serializable

data class PortBinding(val hostIp: String? = null, val hostPort: String? = null)

PortBinding represents a binding between a host IP address and a host port.

PortStatus

@Serializable

data class PortStatus(val ports: List<EndpointPortConfig>? = null)

represents the port status of a task's host ports whose service has published host ports

ProcessConfig

@Serializable

data class ProcessConfig(val privileged: Boolean? = null, val user: String? = null, val tty: Boolean? = null, val entrypoint: String? = null, val arguments: List<String>? = null)

ProgressDetail

@Serializable

data class ProgressDetail(val current: Int? = null, val total: Int? = null)

PushImageInfo

@Serializable

data class PushImageInfo(val error: String? = null, val errorDetail: ErrorDetail? = null, val status: String? = null, val progress: String? = null, val progressDetail: ProgressDetail? = null)

Reachability

@Serializable

enum Reachability : Enum<Reachability>

Reachability represents the reachability of a node.

RegistryServiceConfig

@Serializable

data class RegistryServiceConfig(val insecureRegistryCIDRs: List<String>? = null, val indexConfigs: Map<String, IndexInfo>? = null, val mirrors: List<String>? = null)

RegistryServiceConfig stores daemon registry services configuration.

ResourceObject

@Serializable

data class ResourceObject(val nanoCPUs: Long? = null, val memoryBytes: Long? = null, val genericResources: List<GenericResourcesInner>? = null)

An object describing the resources which can be advertised by a node and requested by a task.

Resources

@Serializable

data class Resources(val cpuShares: Int? = null, val memory: Long? = 0, val cgroupParent: String? = null, val blkioWeight: Int? = null, val blkioWeightDevice: List<ResourcesBlkioWeightDeviceInner>? = null, val blkioDeviceReadBps: List<ThrottleDevice>? = null, val blkioDeviceWriteBps: List<ThrottleDevice>? = null, val blkioDeviceReadIOps: List<ThrottleDevice>? = null, val blkioDeviceWriteIOps: List<ThrottleDevice>? = null, val cpuPeriod: Long? = null, val cpuQuota: Long? = null, val cpuRealtimePeriod: Long? = null, val cpuRealtimeRuntime: Long? = null, val cpusetCpus: String? = null, val cpusetMems: String? = null, val devices: List<DeviceMapping>? = null, val deviceCgroupRules: List<String>? = null, val deviceRequests: List<DeviceRequest>? = null, val kernelMemoryTCP: Long? = null, val memoryReservation: Long? = null, val memorySwap: Long? = null, val memorySwappiness: Long? = null, val nanoCpus: Long? = null, val oomKillDisable: Boolean? = null, val init: Boolean? = null, val pidsLimit: Long? = null, val ulimits: List<ResourcesUlimitsInner>? = null, val cpuCount: Long? = null, val cpuPercent: Long? = null, val ioMaximumIOps: Long? = null, val ioMaximumBandwidth: Long? = null)

A container's resources (cgroups config, ulimits, etc)

ResourcesBlkioWeightDeviceInner

@Serializable

data class ResourcesBlkioWeightDeviceInner(val path: String? = null, val weight: Int? = null)

ResourcesUlimitsInner

@Serializable

data class ResourcesUlimitsInner(val name: String? = null, val soft: Int? = null, val hard: Int? = null)

RestartPolicy

@Serializable

data class RestartPolicy(val name: RestartPolicy.Name? = null, val maximumRetryCount: Int? = null)

The behavior to apply when the container exits. The default is not to restart. An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.

Result

@JvmInline

value class Result<out T, out E>(unboxed: Any?)

Runtime

@Serializable

data class Runtime(val path: String? = null, val runtimeArgs: List<String>? = null, val status: Map<String, String>? = null)

Runtime describes an OCI compliant runtime. The runtime is invoked by the daemon via the containerd daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.

Secret

@Serializable

data class Secret(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: SecretSpec? = null)

SecretCreateRequest

@Serializable

data class SecretCreateRequest(val name: String? = null, val labels: Map<String, String>? = null, val data: String? = null, val driver: Driver? = null, val templating: Driver? = null)

SecretSpec

@Serializable

data class SecretSpec(val name: String? = null, val labels: Map<String, String>? = null, val data: String? = null, val driver: Driver? = null, val templating: Driver? = null)

Service

@Serializable

data class Service(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: ServiceSpec? = null, val endpoint: ServiceEndpoint? = null, val updateStatus: ServiceUpdateStatus? = null, val serviceStatus: ServiceServiceStatus? = null, val jobStatus: ServiceJobStatus? = null)

ServiceCreateRequest

@Serializable

data class ServiceCreateRequest(val name: String? = null, val labels: Map<String, String>? = null, val taskTemplate: TaskSpec? = null, val mode: ServiceSpecMode? = null, val updateConfig: ServiceSpecUpdateConfig? = null, val rollbackConfig: ServiceSpecRollbackConfig? = null, val networks: List<NetworkAttachmentConfig>? = null, val endpointSpec: EndpointSpec? = null)

ServiceCreateResponse

@Serializable

data class ServiceCreateResponse(val ID: String? = null, val warnings: List<String>? = null)

contains the information returned to a client on the creation of a new service.

ServiceEndpoint

@Serializable

data class ServiceEndpoint(val spec: EndpointSpec? = null, val ports: List<EndpointPortConfig>? = null, val virtualIPs: List<ServiceEndpointVirtualIPsInner>? = null)

ServiceEndpointVirtualIPsInner

@Serializable

data class ServiceEndpointVirtualIPsInner(val networkID: String? = null, val addr: String? = null)

ServiceJobStatus

@Serializable

data class ServiceJobStatus(val jobIteration: ObjectVersion? = null, val lastExecution: String? = null)

The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service's version, does not need to be sent with an update request.

ServiceServiceStatus

@Serializable

data class ServiceServiceStatus(val runningTasks: Int? = null, val desiredTasks: Int? = null, val completedTasks: Int? = null)

The status of the service's tasks. Provided only when requested as part of a ServiceList operation.

ServiceSpec

@Serializable

data class ServiceSpec(val name: String? = null, val labels: Map<String, String>? = null, val taskTemplate: TaskSpec? = null, val mode: ServiceSpecMode? = null, val updateConfig: ServiceSpecUpdateConfig? = null, val rollbackConfig: ServiceSpecRollbackConfig? = null, val networks: List<NetworkAttachmentConfig>? = null, val endpointSpec: EndpointSpec? = null)

User modifiable configuration for a service.

ServiceSpecMode

@Serializable

data class ServiceSpecMode(val replicated: ServiceSpecModeReplicated? = null, val global: JsonObject? = null, val replicatedJob: ServiceSpecModeReplicatedJob? = null, val globalJob: JsonObject? = null)

Scheduling mode for the service.

ServiceSpecModeReplicated

@Serializable

data class ServiceSpecModeReplicated(val replicas: Long? = null)

ServiceSpecModeReplicatedJob

@Serializable

data class ServiceSpecModeReplicatedJob(val maxConcurrent: Long? = 1, val totalCompletions: Long? = null)

The mode used for services with a finite number of tasks that run to a completed state.

ServiceSpecRollbackConfig

@Serializable

data class ServiceSpecRollbackConfig(val parallelism: Long? = null, val delay: Long? = null, val failureAction: ServiceSpecRollbackConfig.FailureAction? = null, val monitor: Long? = null, val maxFailureRatio: Double? = null, val order: ServiceSpecRollbackConfig.Order? = null)

Specification for the rollback strategy of the service.

ServiceSpecUpdateConfig

@Serializable

data class ServiceSpecUpdateConfig(val parallelism: Long? = null, val delay: Long? = null, val failureAction: ServiceSpecUpdateConfig.FailureAction? = null, val monitor: Long? = null, val maxFailureRatio: Double? = null, val order: ServiceSpecUpdateConfig.Order? = null)

Specification for the update strategy of the service.

ServiceUpdateRequest

@Serializable

data class ServiceUpdateRequest(val name: String? = null, val labels: Map<String, String>? = null, val taskTemplate: TaskSpec? = null, val mode: ServiceSpecMode? = null, val updateConfig: ServiceSpecUpdateConfig? = null, val rollbackConfig: ServiceSpecRollbackConfig? = null, val networks: List<NetworkAttachmentConfig>? = null, val endpointSpec: EndpointSpec? = null)

ServiceUpdateResponse

@Serializable

data class ServiceUpdateResponse(val warnings: List<String>? = null)

ServiceUpdateStatus

@Serializable

data class ServiceUpdateStatus(val state: ServiceUpdateStatus.State? = null, val startedAt: String? = null, val completedAt: String? = null, val message: String? = null)

The status of a service update.

Swarm

@Serializable

data class Swarm(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val spec: SwarmSpec? = null, val tlSInfo: TLSInfo? = null, val rootRotationInProgress: Boolean? = null, val dataPathPort: Int? = null, val defaultAddrPool: List<String>? = null, val subnetSize: Int? = null, val joinTokens: JoinTokens? = null)

SwarmInfo

@Serializable

data class SwarmInfo(val nodeID: String? = "", val nodeAddr: String? = "", val localNodeState: LocalNodeState? = LocalNodeState.EMPTY, val controlAvailable: Boolean? = false, val error: String? = "", val remoteManagers: List<PeerNode>? = null, val nodes: Int? = null, val managers: Int? = null, val cluster: ClusterInfo? = null)

Represents generic information about swarm.

SwarmInitRequest

@Serializable

data class SwarmInitRequest(val listenAddr: String? = null, val advertiseAddr: String? = null, val dataPathAddr: String? = null, val dataPathPort: Int? = null, val defaultAddrPool: List<String>? = null, val forceNewCluster: Boolean? = null, val subnetSize: Int? = null, val spec: SwarmSpec? = null)

SwarmJoinRequest

@Serializable

data class SwarmJoinRequest(val listenAddr: String? = null, val advertiseAddr: String? = null, val dataPathAddr: String? = null, val remoteAddrs: List<String>? = null, val joinToken: String? = null)

SwarmSpec

@Serializable

data class SwarmSpec(val name: String? = null, val labels: Map<String, String>? = null, val orchestration: SwarmSpecOrchestration? = null, val raft: SwarmSpecRaft? = null, val dispatcher: SwarmSpecDispatcher? = null, val caConfig: SwarmSpecCAConfig? = null, val encryptionConfig: SwarmSpecEncryptionConfig? = null, val taskDefaults: SwarmSpecTaskDefaults? = null)

User modifiable swarm configuration.

SwarmSpecCAConfig

@Serializable

data class SwarmSpecCAConfig(val nodeCertExpiry: Long? = null, val externalCAs: List<SwarmSpecCAConfigExternalCAsInner>? = null, val signingCACert: String? = null, val signingCAKey: String? = null, val forceRotate: Int? = null)

CA configuration.

SwarmSpecCAConfigExternalCAsInner

@Serializable

data class SwarmSpecCAConfigExternalCAsInner(val protocol: SwarmSpecCAConfigExternalCAsInner.Protocol? = Protocol.CFSSL, val URL: String? = null, val options: Map<String, String>? = null, val caCert: String? = null)

SwarmSpecDispatcher

@Serializable

data class SwarmSpecDispatcher(val heartbeatPeriod: Long? = null)

Dispatcher configuration.

SwarmSpecEncryptionConfig

@Serializable

data class SwarmSpecEncryptionConfig(val autoLockManagers: Boolean? = null)

Parameters related to encryption-at-rest.

SwarmSpecOrchestration

@Serializable

data class SwarmSpecOrchestration(val taskHistoryRetentionLimit: Long? = null)

Orchestration configuration.

SwarmSpecRaft

@Serializable

data class SwarmSpecRaft(val snapshotInterval: Int? = null, val keepOldSnapshots: Int? = null, val logEntriesForSlowFollowers: Int? = null, val electionTick: Int? = null, val heartbeatTick: Int? = null)

Raft configuration.

SwarmSpecTaskDefaults

@Serializable

data class SwarmSpecTaskDefaults(val logDriver: SwarmSpecTaskDefaultsLogDriver? = null)

Defaults for creating tasks in this cluster.

SwarmSpecTaskDefaultsLogDriver

@Serializable

data class SwarmSpecTaskDefaultsLogDriver(val name: String? = null, val options: Map<String, String>? = null)

The log driver to use for tasks created in the orchestrator if unspecified by a service. Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated.

SwarmUnlockRequest

@Serializable

data class SwarmUnlockRequest(val unlockKey: String? = null)

SystemAuthResponse

@Serializable

data class SystemAuthResponse(val status: String, val identityToken: String? = null)

SystemDataUsageResponse

@Serializable

data class SystemDataUsageResponse(val layersSize: Long? = null, val images: List<ImageSummary>? = null, val containers: List<ContainerSummary>? = null, val volumes: List<Volume>? = null, val buildCache: List<BuildCache>? = null)

SystemInfo

@Serializable

data class SystemInfo(val ID: String? = null, val containers: Int? = null, val containersRunning: Int? = null, val containersPaused: Int? = null, val containersStopped: Int? = null, val images: Int? = null, val driver: String? = null, val driverStatus: List<List<String>>? = null, val dockerRootDir: String? = null, val plugins: PluginsInfo? = null, val memoryLimit: Boolean? = null, val swapLimit: Boolean? = null, val kernelMemoryTCP: Boolean? = null, val cpuCfsPeriod: Boolean? = null, val cpuCfsQuota: Boolean? = null, val cpUShares: Boolean? = null, val cpUSet: Boolean? = null, val pidsLimit: Boolean? = null, val oomKillDisable: Boolean? = null, val ipv4Forwarding: Boolean? = null, val bridgeNfIptables: Boolean? = null, val bridgeNfIp6tables: Boolean? = null, val debug: Boolean? = null, val nfd: Int? = null, val ngoroutines: Int? = null, val systemTime: String? = null, val loggingDriver: String? = null, val cgroupDriver: SystemInfo.CgroupDriver? = CgroupDriver.CGROUPFS, val cgroupVersion: SystemInfo.CgroupVersion? = CgroupVersion._1, val neventsListener: Int? = null, val kernelVersion: String? = null, val operatingSystem: String? = null, val osVersion: String? = null, val osType: String? = null, val architecture: String? = null, val NCPU: Int? = null, val memTotal: Long? = null, val indexServerAddress: String? = "https://index.docker.io/v1/", val registryConfig: RegistryServiceConfig? = null, val genericResources: List<GenericResourcesInner>? = null, val httpProxy: String? = null, val httpsProxy: String? = null, val noProxy: String? = null, val name: String? = null, val labels: List<String>? = null, val experimentalBuild: Boolean? = null, val serverVersion: String? = null, val runtimes: Map<String, Runtime>? = null, val defaultRuntime: String? = "runc", val swarm: SwarmInfo? = null, val liveRestoreEnabled: Boolean? = false, val isolation: SystemInfo.Isolation? = Isolation.DEFAULT, val initBinary: String? = null, val containerdCommit: Commit? = null, val runcCommit: Commit? = null, val initCommit: Commit? = null, val securityOptions: List<String>? = null, val productLicense: String? = null, val defaultAddressPools: List<SystemInfoDefaultAddressPoolsInner>? = null, val firewallBackend: FirewallInfo? = null, val discoveredDevices: List<DeviceInfo>? = null, val warnings: List<String>? = null, val cdISpecDirs: List<String>? = null, val containerd: ContainerdInfo? = null)

SystemInfoDefaultAddressPoolsInner

@Serializable

data class SystemInfoDefaultAddressPoolsInner(val base: String? = null, val propertySize: Int? = null)

SystemVersion

@Serializable

data class SystemVersion(val platform: SystemVersionPlatform? = null, val components: List<SystemVersionComponentsInner>? = null, val version: String? = null, val apiVersion: String? = null, val minAPIVersion: String? = null, val gitCommit: String? = null, val goVersion: String? = null, val os: String? = null, val arch: String? = null, val kernelVersion: String? = null, val experimental: Boolean? = null, val buildTime: String? = null)

Response of Engine API: GET \"/version\"

SystemVersionComponentsInner

@Serializable

data class SystemVersionComponentsInner(val name: String, val version: String, val details: JsonObject? = null)

SystemVersionPlatform

@Serializable

data class SystemVersionPlatform(val name: String)

Task

@Serializable

data class Task(val ID: String? = null, val version: ObjectVersion? = null, val createdAt: String? = null, val updatedAt: String? = null, val name: String? = null, val labels: Map<String, String>? = null, val spec: TaskSpec? = null, val serviceID: String? = null, val slot: Int? = null, val nodeID: String? = null, val assignedGenericResources: List<GenericResourcesInner>? = null, val status: TaskStatus? = null, val desiredState: TaskState? = null, val jobIteration: ObjectVersion? = null)

TaskSpec

@Serializable

data class TaskSpec(val pluginSpec: TaskSpecPluginSpec? = null, val containerSpec: TaskSpecContainerSpec? = null, val networkAttachmentSpec: TaskSpecNetworkAttachmentSpec? = null, val resources: TaskSpecResources? = null, val restartPolicy: TaskSpecRestartPolicy? = null, val placement: TaskSpecPlacement? = null, val forceUpdate: Int? = null, val runtime: String? = null, val networks: List<NetworkAttachmentConfig>? = null, val logDriver: TaskSpecLogDriver? = null)

User modifiable task configuration.

TaskSpecContainerSpec

@Serializable

data class TaskSpecContainerSpec(val image: String? = null, val labels: Map<String, String>? = null, val command: List<String>? = null, val args: List<String>? = null, val hostname: String? = null, val env: List<String>? = null, val dir: String? = null, val user: String? = null, val groups: List<String>? = null, val privileges: TaskSpecContainerSpecPrivileges? = null, val TTY: Boolean? = null, val openStdin: Boolean? = null, val readOnly: Boolean? = null, val mounts: List<Mount>? = null, val stopSignal: String? = null, val stopGracePeriod: Long? = null, val healthCheck: HealthConfig? = null, val hosts: List<String>? = null, val dnSConfig: TaskSpecContainerSpecDNSConfig? = null, val secrets: List<TaskSpecContainerSpecSecretsInner>? = null, val oomScoreAdj: Long? = null, val configs: List<TaskSpecContainerSpecConfigsInner>? = null, val isolation: TaskSpecContainerSpec.Isolation? = null, val init: Boolean? = null, val sysctls: Map<String, String>? = null, val capabilityAdd: List<String>? = null, val capabilityDrop: List<String>? = null, val ulimits: List<ResourcesUlimitsInner>? = null)

Container spec for the service.

>Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to plugin. NetworkAttachmentSpec is used when the Runtime > field is set to attachment.

TaskSpecContainerSpecConfigsInner

@Serializable

data class TaskSpecContainerSpecConfigsInner(val file: TaskSpecContainerSpecConfigsInnerFile? = null, val runtime: JsonObject? = null, val configID: String? = null, val configName: String? = null)

TaskSpecContainerSpecConfigsInnerFile

@Serializable

data class TaskSpecContainerSpecConfigsInnerFile(val name: String? = null, val UID: String? = null, val GID: String? = null, val mode: Int? = null)

File represents a specific target that is backed by a file.

>Note: Configs.File and Configs.Runtime are mutually exclusive

TaskSpecContainerSpecDNSConfig

@Serializable

data class TaskSpecContainerSpecDNSConfig(val nameservers: List<String>? = null, val search: List<String>? = null, val options: List<String>? = null)

Specification for DNS related configurations in resolver configuration file (resolv.conf).

TaskSpecContainerSpecPrivileges

@Serializable

data class TaskSpecContainerSpecPrivileges(val credentialSpec: TaskSpecContainerSpecPrivilegesCredentialSpec? = null, val seLinuxContext: TaskSpecContainerSpecPrivilegesSELinuxContext? = null, val seccomp: TaskSpecContainerSpecPrivilegesSeccomp? = null, val appArmor: TaskSpecContainerSpecPrivilegesAppArmor? = null, val noNewPrivileges: Boolean? = null)

Security options for the container

TaskSpecContainerSpecPrivilegesAppArmor

@Serializable

data class TaskSpecContainerSpecPrivilegesAppArmor(val mode: TaskSpecContainerSpecPrivilegesAppArmor.Mode? = null)

Options for configuring AppArmor on the container

TaskSpecContainerSpecPrivilegesCredentialSpec

@Serializable

data class TaskSpecContainerSpecPrivilegesCredentialSpec(val config: String? = null, val file: String? = null, val registry: String? = null)

CredentialSpec for managed service account (Windows only)

TaskSpecContainerSpecPrivilegesSeccomp

@Serializable

data class TaskSpecContainerSpecPrivilegesSeccomp(val mode: TaskSpecContainerSpecPrivilegesSeccomp.Mode? = null, val profile: String? = null)

Options for configuring seccomp on the container

TaskSpecContainerSpecPrivilegesSELinuxContext

@Serializable

data class TaskSpecContainerSpecPrivilegesSELinuxContext(val disable: Boolean? = null, val user: String? = null, val role: String? = null, val type: String? = null, val level: String? = null)

SELinux labels of the container

TaskSpecContainerSpecSecretsInner

@Serializable

data class TaskSpecContainerSpecSecretsInner(val file: TaskSpecContainerSpecSecretsInnerFile? = null, val secretID: String? = null, val secretName: String? = null)

TaskSpecContainerSpecSecretsInnerFile

@Serializable

data class TaskSpecContainerSpecSecretsInnerFile(val name: String? = null, val UID: String? = null, val GID: String? = null, val mode: Int? = null)

File represents a specific target that is backed by a file.

TaskSpecLogDriver

@Serializable

data class TaskSpecLogDriver(val name: String? = null, val options: Map<String, String>? = null)

Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified.

TaskSpecNetworkAttachmentSpec

@Serializable

data class TaskSpecNetworkAttachmentSpec(val containerID: String? = null)

Read-only spec type for non-swarm containers attached to swarm overlay networks.

TaskSpecPlacement

@Serializable

data class TaskSpecPlacement(val constraints: List<String>? = null, val preferences: List<TaskSpecPlacementPreferencesInner>? = null, val maxReplicas: Long? = 0, val platforms: List<Platform>? = null)

TaskSpecPlacementPreferencesInner

@Serializable

data class TaskSpecPlacementPreferencesInner(val spread: TaskSpecPlacementPreferencesInnerSpread? = null)

TaskSpecPlacementPreferencesInnerSpread

@Serializable

data class TaskSpecPlacementPreferencesInnerSpread(val spreadDescriptor: String? = null)

TaskSpecPluginSpec

@Serializable

data class TaskSpecPluginSpec(val name: String? = null, val remote: String? = null, val disabled: Boolean? = null, val pluginPrivilege: List<PluginPrivilege>? = null)

Plugin spec for the service. (Experimental release only.)

TaskSpecResources

@Serializable

data class TaskSpecResources(val limits: Limit? = null, val reservations: ResourceObject? = null)

Resource requirements which apply to each individual container created as part of the service.

TaskSpecRestartPolicy

@Serializable

data class TaskSpecRestartPolicy(val condition: TaskSpecRestartPolicy.Condition? = null, val delay: Long? = null, val maxAttempts: Long? = 0, val window: Long? = 0)

Specification for the restart policy which applies to containers created as part of this service.

TaskState

@Serializable

enum TaskState : Enum<TaskState>

Values: NEW,ALLOCATED,PENDING,ASSIGNED,ACCEPTED,PREPARING,READY,STARTING,RUNNING,COMPLETE,SHUTDOWN,FAILED,REJECTED,REMOVE,ORPHANED

TaskStatus

@Serializable

data class TaskStatus(val timestamp: String? = null, val state: TaskState? = null, val message: String? = null, val err: String? = null, val containerStatus: ContainerStatus? = null, val portStatus: PortStatus? = null)

represents the status of a task.

ThrottleDevice

@Serializable

data class ThrottleDevice(val path: String? = null, val rate: Long? = null)

TLSInfo

@Serializable

data class TLSInfo(val trustRoot: String? = null, val certIssuerSubject: String? = null, val certIssuerPublicKey: String? = null)

Information about the issuer of leaf TLS certificates and the trusted root CA certificate.

UnlockKeyResponse

@Serializable

data class UnlockKeyResponse(val unlockKey: String? = null)

Volume

@Serializable

data class Volume(val name: String, val driver: String, val mountpoint: String, val scope: Volume.Scope = Scope.LOCAL, val options: Map<String, String>?, val createdAt: String? = null, val status: Map<String, JsonObject>? = null, val labels: Map<String, String>? = null, val clusterVolume: ClusterVolume? = null, val usageData: VolumeUsageData? = null)

VolumeCreateOptions

@Serializable

data class VolumeCreateOptions(val name: String? = null, val driver: String? = "local", val driverOpts: Map<String, String>? = null, val labels: Map<String, String>? = null, val clusterVolumeSpec: ClusterVolumeSpec? = null)

Volume configuration

VolumeListResponse

@Serializable

data class VolumeListResponse(val volumes: List<Volume>? = null, val warnings: List<String>? = null)

Volume list response

VolumePruneResponse

@Serializable

data class VolumePruneResponse(val volumesDeleted: List<String>? = null, val spaceReclaimed: Long? = null)

VolumeUpdateRequest

@Serializable

data class VolumeUpdateRequest(val spec: ClusterVolumeSpec? = null)

Volume configuration

VolumeUsageData

@Serializable

data class VolumeUsageData(val propertySize: Long = -1L, val refCount: Long = -1L)

Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.

Functions

asError

fun <E> E.asError(): Result<Nothing, E>

asSuccess

fun <T> T.asSuccess(): Result<T, Nothing>