ContainerRepository¶

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

Bases: object

Container repository metadata.

Attributes

`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a ContainerRepository.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ContainerRepository.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ContainerRepository.
`REPOSITORY_TYPE_MULTI_REGION`	A constant which can be used with the repository_type property of a ContainerRepository.
`REPOSITORY_TYPE_PULL_THROUGH`	A constant which can be used with the repository_type property of a ContainerRepository.
`REPOSITORY_TYPE_STANDARD`	A constant which can be used with the repository_type property of a ContainerRepository.
`billable_size_in_gbs`	[Required] Gets the billable_size_in_gbs of this ContainerRepository.
`compartment_id`	[Required] Gets the compartment_id of this ContainerRepository.
`created_by`	[Required] Gets the created_by of this ContainerRepository.
`defined_tags`	[Required] Gets the defined_tags of this ContainerRepository.
`display_name`	[Required] Gets the display_name of this ContainerRepository.
`freeform_tags`	[Required] Gets the freeform_tags of this ContainerRepository.
`id`	[Required] Gets the id of this ContainerRepository.
`image_count`	[Required] Gets the image_count of this ContainerRepository.
`is_immutable`	[Required] Gets the is_immutable of this ContainerRepository.
`is_public`	[Required] Gets the is_public of this ContainerRepository.
`is_top_level`	Gets the is_top_level of this ContainerRepository.
`layer_count`	[Required] Gets the layer_count of this ContainerRepository.
`layers_size_in_bytes`	[Required] Gets the layers_size_in_bytes of this ContainerRepository.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ContainerRepository.
`multi_region_peers`	Gets the multi_region_peers of this ContainerRepository.
`namespace`	[Required] Gets the namespace of this ContainerRepository.
`readme`	Gets the readme of this ContainerRepository.
`repository_type`	Gets the repository_type of this ContainerRepository.
`system_tags`	[Required] Gets the system_tags of this ContainerRepository.
`time_created`	[Required] Gets the time_created of this ContainerRepository.
`time_last_pushed`	Gets the time_last_pushed of this ContainerRepository.
`upstream_secret_id`	Gets the upstream_secret_id of this ContainerRepository.
`upstream_url`	Gets the upstream_url of this ContainerRepository.
`upstream_username`	Gets the upstream_username of this ContainerRepository.

Methods

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

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

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

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

REPOSITORY_TYPE_MULTI_REGION = 'MULTI_REGION'¶: A constant which can be used with the repository_type property of a ContainerRepository. This constant has a value of “MULTI_REGION”

REPOSITORY_TYPE_PULL_THROUGH = 'PULL_THROUGH'¶: A constant which can be used with the repository_type property of a ContainerRepository. This constant has a value of “PULL_THROUGH”

REPOSITORY_TYPE_STANDARD = 'STANDARD'¶: A constant which can be used with the repository_type property of a ContainerRepository. This constant has a value of “STANDARD”

__init__(**kwargs)¶

Initializes a new ContainerRepository 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 ContainerRepository.
created_by (str) – The value to assign to the created_by property of this ContainerRepository.
display_name (str) – The value to assign to the display_name property of this ContainerRepository.
id (str) – The value to assign to the id property of this ContainerRepository.
image_count (int) – The value to assign to the image_count property of this ContainerRepository.
is_immutable (bool) – The value to assign to the is_immutable property of this ContainerRepository.
is_public (bool) – The value to assign to the is_public property of this ContainerRepository.
layer_count (int) – The value to assign to the layer_count property of this ContainerRepository.
layers_size_in_bytes (int) – The value to assign to the layers_size_in_bytes property of this ContainerRepository.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ContainerRepository. Allowed values for this property are: “AVAILABLE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
readme (oci.artifacts.models.ContainerRepositoryReadme) – The value to assign to the readme property of this ContainerRepository.
time_created (datetime) – The value to assign to the time_created property of this ContainerRepository.
time_last_pushed (datetime) – The value to assign to the time_last_pushed property of this ContainerRepository.
billable_size_in_gbs (int) – The value to assign to the billable_size_in_gbs property of this ContainerRepository.
namespace (str) – The value to assign to the namespace property of this ContainerRepository.
repository_type (str) – The value to assign to the repository_type property of this ContainerRepository. Allowed values for this property are: “STANDARD”, “PULL_THROUGH”, “MULTI_REGION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_top_level (bool) – The value to assign to the is_top_level property of this ContainerRepository.
upstream_url (str) – The value to assign to the upstream_url property of this ContainerRepository.
upstream_username (str) – The value to assign to the upstream_username property of this ContainerRepository.
upstream_secret_id (str) – The value to assign to the upstream_secret_id property of this ContainerRepository.
multi_region_peers (list[str]) – The value to assign to the multi_region_peers property of this ContainerRepository.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ContainerRepository.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ContainerRepository.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ContainerRepository.

billable_size_in_gbs¶

[Required] Gets the billable_size_in_gbs of this ContainerRepository. Total storage size in GBs that will be charged.

Returns:	The billable_size_in_gbs of this ContainerRepository.
Return type:	int

compartment_id¶

[Required] Gets the compartment_id of this ContainerRepository. The OCID of the compartment in which the container repository exists.

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

created_by¶

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

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

defined_tags¶

[Required] Gets the defined_tags of this ContainerRepository. 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 ContainerRepository.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ContainerRepository. The container repository name.

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

freeform_tags¶

[Required] Gets the freeform_tags of this ContainerRepository. 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 ContainerRepository.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ContainerRepository. The OCID of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID

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

image_count¶

[Required] Gets the image_count of this ContainerRepository. Total number of images.

Returns:	The image_count of this ContainerRepository.
Return type:	int

is_immutable¶

[Required] Gets the is_immutable of this ContainerRepository. Whether the repository is immutable. Images cannot be overwritten in an immutable repository.

Returns:	The is_immutable of this ContainerRepository.
Return type:	bool

is_public¶

[Required] Gets the is_public of this ContainerRepository. Whether the repository is public. A public repository allows unauthenticated access.

Returns:	The is_public of this ContainerRepository.
Return type:	bool

is_top_level¶

Gets the is_top_level of this ContainerRepository. Whether the repository is top-level. A top-level repository reserves its name in namespace as a prefix and allows images to be hosted under child paths of that prefix.

Returns:	The is_top_level of this ContainerRepository.
Return type:	bool

layer_count¶

[Required] Gets the layer_count of this ContainerRepository. Total number of layers.

Returns:	The layer_count of this ContainerRepository.
Return type:	int

layers_size_in_bytes¶

[Required] Gets the layers_size_in_bytes of this ContainerRepository. Total storage in bytes consumed by layers.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ContainerRepository. The current state of the container repository.

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

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

multi_region_peers¶

Gets the multi_region_peers of this ContainerRepository. List of peer regions that define the multi-region group. Peer regions must be specified using canonical region names (for example, us-phoenix-1). The peer set must match a supported multi-region endpoint group and MUST include the local OCIR region where the repository is created.

Returns:	The multi_region_peers of this ContainerRepository.
Return type:	list[str]

namespace¶

[Required] Gets the namespace of this ContainerRepository. The tenancy namespace used in the container repository path.

Returns:	The namespace of this ContainerRepository.
Return type:	str

readme¶

Gets the readme of this ContainerRepository.

Returns:	The readme of this ContainerRepository.
Return type:	oci.artifacts.models.ContainerRepositoryReadme

repository_type¶

Gets the repository_type of this ContainerRepository. The type of container repository. This determines the repository behavior and required settings.

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

Returns:	The repository_type of this ContainerRepository.
Return type:	str

system_tags¶

[Required] Gets the system_tags of this ContainerRepository. 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 ContainerRepository.
Return type:	dict(str, dict(str, object))

time_created¶

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

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

time_last_pushed¶

Gets the time_last_pushed of this ContainerRepository. An RFC 3339 timestamp indicating when an image was last pushed to the repository.

Returns:	The time_last_pushed of this ContainerRepository.
Return type:	datetime

upstream_secret_id¶

Gets the upstream_secret_id of this ContainerRepository. The OCID of the OCI Vault secret that contains the upstream registry password as base64 encoded string for a pull-through cache repository.

Returns:	The upstream_secret_id of this ContainerRepository.
Return type:	str

upstream_url¶

Gets the upstream_url of this ContainerRepository. The upstream registry URL for a pull-through cache repository.

Returns:	The upstream_url of this ContainerRepository.
Return type:	str

upstream_username¶

Gets the upstream_username of this ContainerRepository. The upstream registry username for a pull-through cache repository.

Returns:	The upstream_username of this ContainerRepository.
Return type:	str