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)

Parameters

id

The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes).

names

The names associated with this container. Most containers have a single name, but when using legacy \"links\", the container can have multiple names. For historic reasons, names are prefixed with a forward-slash (/).

image

The name or ID of the image used to create the container. This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., docker.io/library/ubuntu:latest or docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782), short form (e.g., ubuntu:latest)), or the ID(-prefix) of the image (e.g., 72297848456d). The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782).

imageID

The ID (digest) of the image that this container was created from.

imageManifestDescriptor
command

Command to run when starting the container

created

Date and time at which the container was created as a Unix timestamp (number of seconds since EPOCH).

ports

Port-mappings for the container.

sizeRw

The size of files that have been created or changed by this container. This field is omitted by default, and only set when size is requested in the API request.

sizeRootFs

The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers. This field is omitted by default, and only set when size is requested in the API request.

labels

User-defined key/value metadata.

state

The state of this container.

status

Additional human-readable status of this container (e.g. Exit 0)

hostConfig
networkSettings
mounts

List of mounts used by the container.

Constructors

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

Types

Link copied to clipboard
@Serializable
enum State : Enum<ContainerSummary.State>

The state of this container.

Properties

Link copied to clipboard
@SerialName(value = "Command")
val command: String?
Link copied to clipboard
@SerialName(value = "Created")
val created: Long?
Link copied to clipboard
@SerialName(value = "HostConfig")
val hostConfig: ContainerSummaryHostConfig?
Link copied to clipboard
@SerialName(value = "Id")
val id: String?
Link copied to clipboard
@SerialName(value = "Image")
val image: String?
Link copied to clipboard
@SerialName(value = "ImageID")
val imageID: String?
Link copied to clipboard
@SerialName(value = "ImageManifestDescriptor")
val imageManifestDescriptor: OCIDescriptor?
Link copied to clipboard
@SerialName(value = "Labels")
val labels: Map<String, String>?
Link copied to clipboard
@SerialName(value = "Mounts")
val mounts: List<MountPoint>?
Link copied to clipboard
@SerialName(value = "Names")
val names: List<String>?
Link copied to clipboard
@SerialName(value = "NetworkSettings")
val networkSettings: ContainerSummaryNetworkSettings?
Link copied to clipboard
@SerialName(value = "Ports")
val ports: List<Port>?
Link copied to clipboard
@SerialName(value = "SizeRootFs")
val sizeRootFs: Long?
Link copied to clipboard
@SerialName(value = "SizeRw")
val sizeRw: Long?
Link copied to clipboard
@SerialName(value = "State")
val state: ContainerSummary.State?
Link copied to clipboard
@SerialName(value = "Status")
val status: String?