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)

Parameters

id

ID is the content-addressable ID of an image. This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image). Note that this digest differs from the RepoDigests below, which holds digests of image manifests that reference the image.

parentId

ID of the parent image. Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry.

created

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

propertySize

Total size of the image including all layers it is composed of.

sharedSize

Total size of image layers that are shared between this image and other images. This size is not calculated by default. -1 indicates that the value has not been set / calculated.

labels

User-defined key/value metadata.

containers

Number of containers using this image. Includes both stopped and running containers. -1 indicates that the value has not been set / calculated.

repoTags

List of image names/tags in the local image cache that reference this image. Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is \"untagged\", in which case it can still be referenced by its ID.

repoDigests

List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image. These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated.

virtualSize

Total size of the image including all layers it is composed of. Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead.

manifests

Manifests is a list of manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. WARNING: This is experimental and may change at any time without any backward compatibility.

descriptor

Constructors

Link copied to clipboard
constructor(id: String, parentId: String, created: Int, propertySize: Long, sharedSize: Long, labels: Map<String, String>?, containers: Int, repoTags: List<String>? = null, repoDigests: List<String>? = null, virtualSize: Long? = null, manifests: List<ImageManifestSummary>? = null, descriptor: OCIDescriptor? = null)

Properties

Link copied to clipboard
@SerialName(value = "Containers")
@Required
val containers: Int
Link copied to clipboard
@SerialName(value = "Created")
@Required
val created: Int
Link copied to clipboard
@SerialName(value = "Descriptor")
val descriptor: OCIDescriptor?
Link copied to clipboard
@SerialName(value = "Id")
@Required
val id: String
Link copied to clipboard
@SerialName(value = "Labels")
@Required
val labels: Map<String, String>?
Link copied to clipboard
@SerialName(value = "Manifests")
val manifests: List<ImageManifestSummary>?
Link copied to clipboard
@SerialName(value = "ParentId")
@Required
val parentId: String
Link copied to clipboard
@SerialName(value = "Size")
@Required
val propertySize: Long
Link copied to clipboard
@SerialName(value = "RepoDigests")
val repoDigests: List<String>?
Link copied to clipboard
@SerialName(value = "RepoTags")
val repoTags: List<String>?
Link copied to clipboard
@SerialName(value = "SharedSize")
@Required
val sharedSize: Long
Link copied to clipboard
@SerialName(value = "VirtualSize")
val virtualSize: Long?