ContainerImage¶

class oci.artifacts.models.ContainerImage(**kwargs)¶

Bases: object

Container image metadata.

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a ContainerImage.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ContainerImage.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ContainerImage.
`compartment_id`	[Required] Gets the compartment_id of this ContainerImage.
`created_by`	[Required] Gets the created_by of this ContainerImage.
`defined_tags`	[Required] Gets the defined_tags of this ContainerImage.
`digest`	[Required] Gets the digest of this ContainerImage.
`display_name`	[Required] Gets the display_name of this ContainerImage.
`freeform_tags`	[Required] Gets the freeform_tags of this ContainerImage.
`id`	[Required] Gets the id of this ContainerImage.
`layers`	[Required] Gets the layers of this ContainerImage.
`layers_size_in_bytes`	[Required] Gets the layers_size_in_bytes of this ContainerImage.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ContainerImage.
`manifest_size_in_bytes`	[Required] Gets the manifest_size_in_bytes of this ContainerImage.
`pull_count`	[Required] Gets the pull_count of this ContainerImage.
`repository_id`	[Required] Gets the repository_id of this ContainerImage.
`repository_name`	[Required] Gets the repository_name of this ContainerImage.
`system_tags`	[Required] Gets the system_tags of this ContainerImage.
`time_created`	[Required] Gets the time_created of this ContainerImage.
`time_last_pulled`	Gets the time_last_pulled of this ContainerImage.
`version`	Gets the version of this ContainerImage.
`versions`	[Required] Gets the versions of this ContainerImage.

Methods

__init__(**kwargs) Initializes a new ContainerImage object with values from keyword arguments.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a ContainerImage. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ContainerImage. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ContainerImage. This constant has a value of “DELETING”

__init__(**kwargs)¶

Initializes a new ContainerImage object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this ContainerImage.
created_by (str) – The value to assign to the created_by property of this ContainerImage.
digest (str) – The value to assign to the digest property of this ContainerImage.
display_name (str) – The value to assign to the display_name property of this ContainerImage.
id (str) – The value to assign to the id property of this ContainerImage.
layers (list[oci.artifacts.models.ContainerImageLayer]) – The value to assign to the layers property of this ContainerImage.
layers_size_in_bytes (int) – The value to assign to the layers_size_in_bytes property of this ContainerImage.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ContainerImage. Allowed values for this property are: “AVAILABLE”, “DELETED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
manifest_size_in_bytes (int) – The value to assign to the manifest_size_in_bytes property of this ContainerImage.
pull_count (int) – The value to assign to the pull_count property of this ContainerImage.
repository_id (str) – The value to assign to the repository_id property of this ContainerImage.
repository_name (str) – The value to assign to the repository_name property of this ContainerImage.
time_created (datetime) – The value to assign to the time_created property of this ContainerImage.
time_last_pulled (datetime) – The value to assign to the time_last_pulled property of this ContainerImage.
version (str) – The value to assign to the version property of this ContainerImage.
versions (list[oci.artifacts.models.ContainerVersion]) – The value to assign to the versions property of this ContainerImage.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ContainerImage.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ContainerImage.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ContainerImage.

compartment_id¶

[Required] Gets the compartment_id of this ContainerImage. The compartment OCID to which the container image belongs. Inferred from the container repository.

Returns:	The compartment_id of this ContainerImage.
Return type:	str

created_by¶

[Required] Gets the created_by of this ContainerImage. The OCID of the user or principal that created the resource.

Returns:	The created_by of this ContainerImage.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this ContainerImage. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this ContainerImage.
Return type:	dict(str, dict(str, object))

digest¶

[Required] Gets the digest of this ContainerImage. The container image digest.

Returns:	The digest of this ContainerImage.
Return type:	str

display_name¶

[Required] Gets the display_name of this ContainerImage. 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

Returns:	The display_name of this ContainerImage.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this ContainerImage. 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”}

Returns:	The freeform_tags of this ContainerImage.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ContainerImage. The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID

Returns:	The id of this ContainerImage.
Return type:	str

layers¶

[Required] Gets the layers of this ContainerImage. Layers of which the image is composed, ordered by the layer digest.

Returns:	The layers of this ContainerImage.
Return type:	list[oci.artifacts.models.ContainerImageLayer]

layers_size_in_bytes¶

[Required] Gets the layers_size_in_bytes of this ContainerImage. The total size of the container image layers in bytes.

Returns:	The layers_size_in_bytes of this ContainerImage.
Return type:	int

lifecycle_state¶

[Required] Gets the lifecycle_state of this ContainerImage. The current state of the container image.

Allowed values for this property are: “AVAILABLE”, “DELETED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ContainerImage.
Return type:	str

manifest_size_in_bytes¶

[Required] Gets the manifest_size_in_bytes of this ContainerImage. The size of the container image manifest in bytes.

Returns:	The manifest_size_in_bytes of this ContainerImage.
Return type:	int

pull_count¶

[Required] Gets the pull_count of this ContainerImage. Total number of pulls.

Returns:	The pull_count of this ContainerImage.
Return type:	int

repository_id¶

[Required] Gets the repository_id of this ContainerImage. The OCID of the container repository.

Returns:	The repository_id of this ContainerImage.
Return type:	str

repository_name¶

[Required] Gets the repository_name of this ContainerImage. The container repository name.

Returns:	The repository_name of this ContainerImage.
Return type:	str

system_tags¶

[Required] Gets the system_tags of this ContainerImage. The system tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ContainerImage.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ContainerImage. An RFC 3339 timestamp indicating when the image was created.

Returns:	The time_created of this ContainerImage.
Return type:	datetime

time_last_pulled¶

Gets the time_last_pulled of this ContainerImage. An RFC 3339 timestamp indicating when the image was last pulled.

Returns:	The time_last_pulled of this ContainerImage.
Return type:	datetime

version¶

Gets the version of this ContainerImage. The most recent version associated with this image.

Returns:	The version of this ContainerImage.
Return type:	str

versions¶

[Required] Gets the versions of this ContainerImage. The versions associated with this image.

Returns:	The versions of this ContainerImage.
Return type:	list[oci.artifacts.models.ContainerVersion]