Show / Hide Table of Contents

Class ContainerImage

Container image metadata.

Inheritance
object
ContainerImage
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ArtifactsService.Models
Assembly: OCI.DotNetSDK.Artifacts.dll
Syntax
public class ContainerImage

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The compartment OCID to which the container image belongs. Inferred from the container repository.

Remarks

Required

CreatedBy

Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type Description
string

The OCID of the user or principal that created the resource.

Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

Digest

Declaration
[Required(ErrorMessage = "Digest is required.")]
[JsonProperty(PropertyName = "digest")]
public string Digest { get; set; }
Property Value
Type Description
string

The container image digest.

Remarks

Required

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version.
Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

Remarks

Required

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the container image.
Example: ocid1.containerimage.oc1..exampleuniqueID

Remarks

Required

Layers

Declaration
[Required(ErrorMessage = "Layers is required.")]
[JsonProperty(PropertyName = "layers")]
public List<ContainerImageLayer> Layers { get; set; }
Property Value
Type Description
List<ContainerImageLayer>

Layers of which the image is composed, ordered by the layer digest.

Remarks

Required

LayersSizeInBytes

Declaration
[Required(ErrorMessage = "LayersSizeInBytes is required.")]
[JsonProperty(PropertyName = "layersSizeInBytes")]
public long? LayersSizeInBytes { get; set; }
Property Value
Type Description
long?

The total size of the container image layers in bytes.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ContainerImage.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
ContainerImage.LifecycleStateEnum?

The current state of the container image.

Remarks

Required

ManifestSizeInBytes

Declaration
[Required(ErrorMessage = "ManifestSizeInBytes is required.")]
[JsonProperty(PropertyName = "manifestSizeInBytes")]
public int? ManifestSizeInBytes { get; set; }
Property Value
Type Description
int?

The size of the container image manifest in bytes.

Remarks

Required

PullCount

Declaration
[Required(ErrorMessage = "PullCount is required.")]
[JsonProperty(PropertyName = "pullCount")]
public long? PullCount { get; set; }
Property Value
Type Description
long?

Total number of pulls.

Remarks

Required

RepositoryId

Declaration
[Required(ErrorMessage = "RepositoryId is required.")]
[JsonProperty(PropertyName = "repositoryId")]
public string RepositoryId { get; set; }
Property Value
Type Description
string

The OCID of the container repository.

Remarks

Required

RepositoryName

Declaration
[Required(ErrorMessage = "RepositoryName is required.")]
[JsonProperty(PropertyName = "repositoryName")]
public string RepositoryName { get; set; }
Property Value
Type Description
string

The container repository name.

Remarks

Required

SystemTags

Declaration
[Required(ErrorMessage = "SystemTags is required.")]
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

The system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

An RFC 3339 timestamp indicating when the image was created.

Remarks

Required

TimeLastPulled

Declaration
[JsonProperty(PropertyName = "timeLastPulled")]
public DateTime? TimeLastPulled { get; set; }
Property Value
Type Description
DateTime?

An RFC 3339 timestamp indicating when the image was last pulled.

Version

Declaration
[JsonProperty(PropertyName = "version")]
public string Version { get; set; }
Property Value
Type Description
string

The most recent version associated with this image.

Versions

Declaration
[Required(ErrorMessage = "Versions is required.")]
[JsonProperty(PropertyName = "versions")]
public List<ContainerVersion> Versions { get; set; }
Property Value
Type Description
List<ContainerVersion>

The versions associated with this image.

Remarks

Required

In this article
Back to top