CreateContainerRepositoryDetails¶

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

Bases: object

Create container repository details.

Methods:

__init__(**kwargs)

Initializes a new CreateContainerRepositoryDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateContainerRepositoryDetails.
`defined_tags`	Gets the defined_tags of this CreateContainerRepositoryDetails.
`display_name`	[Required] Gets the display_name of this CreateContainerRepositoryDetails.
`freeform_tags`	Gets the freeform_tags of this CreateContainerRepositoryDetails.
`is_immutable`	Gets the is_immutable of this CreateContainerRepositoryDetails.
`is_public`	Gets the is_public of this CreateContainerRepositoryDetails.
`is_top_level`	Gets the is_top_level of this CreateContainerRepositoryDetails.
`multi_region_peers`	Gets the multi_region_peers of this CreateContainerRepositoryDetails.
`readme`	Gets the readme of this CreateContainerRepositoryDetails.
`repository_type`	Gets the repository_type of this CreateContainerRepositoryDetails.
`upstream_secret_id`	Gets the upstream_secret_id of this CreateContainerRepositoryDetails.
`upstream_url`	Gets the upstream_url of this CreateContainerRepositoryDetails.
`upstream_username`	Gets the upstream_username of this CreateContainerRepositoryDetails.

__init__(**kwargs)¶

Initializes a new CreateContainerRepositoryDetails 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 CreateContainerRepositoryDetails.
display_name (str) – The value to assign to the display_name property of this CreateContainerRepositoryDetails.
repository_type (str) – The value to assign to the repository_type property of this CreateContainerRepositoryDetails.
is_top_level (bool) – The value to assign to the is_top_level property of this CreateContainerRepositoryDetails.
upstream_url (str) – The value to assign to the upstream_url property of this CreateContainerRepositoryDetails.
upstream_username (str) – The value to assign to the upstream_username property of this CreateContainerRepositoryDetails.
upstream_secret_id (str) – The value to assign to the upstream_secret_id property of this CreateContainerRepositoryDetails.
multi_region_peers (list[str]) – The value to assign to the multi_region_peers property of this CreateContainerRepositoryDetails.
is_immutable (bool) – The value to assign to the is_immutable property of this CreateContainerRepositoryDetails.
is_public (bool) – The value to assign to the is_public property of this CreateContainerRepositoryDetails.
readme (oci.artifacts.models.ContainerRepositoryReadme) – The value to assign to the readme property of this CreateContainerRepositoryDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateContainerRepositoryDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateContainerRepositoryDetails.

property compartment_id¶

[Required] Gets the compartment_id of this CreateContainerRepositoryDetails. The OCID of the compartment in which to create the resource.

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

property defined_tags¶

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

property display_name¶

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

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

property freeform_tags¶

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

property is_immutable¶

Gets the is_immutable of this CreateContainerRepositoryDetails. Whether the repository is immutable. Images cannot be overwritten in an immutable repository. Currently, setting this flag is not supported yet and is set to false by default.

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

property is_public¶

Gets the is_public of this CreateContainerRepositoryDetails. Whether the repository is public. A public repository allows unauthenticated access.

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

property is_top_level¶

Gets the is_top_level of this CreateContainerRepositoryDetails. 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 CreateContainerRepositoryDetails.
Return type: bool

property multi_region_peers¶

Gets the multi_region_peers of this CreateContainerRepositoryDetails. 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. Required when repositoryType is MULTI_REGION.

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

property readme¶

Gets the readme of this CreateContainerRepositoryDetails.

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

property repository_type¶

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

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

property upstream_secret_id¶

Gets the upstream_secret_id of this CreateContainerRepositoryDetails. The OCID of the OCI Vault secret that contains the upstream registry password as base64 encoded string for a pull-through cache repository. Required when repositoryType is PULL_THROUGH.

Example: ocid1.vaultsecret.oc1..exampleuniqueID

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

property upstream_url¶

Gets the upstream_url of this CreateContainerRepositoryDetails. The upstream registry URL for a pull-through cache repository. Required when repositoryType is PULL_THROUGH. The value must include the registry endpoint and repository path, and must not include a tag or digest.

If isTopLevel is false, the value must be an exact upstream image full path. Example: iad.ocir.io/<upstreamNamespace>/library/ubuntu

If isTopLevel is true, the value must be an upstream repository path prefix, allowing OCIR to pull multiple repositories under that prefix. Example: iad.ocir.io/<upstreamNamespace>/library or iad.ocir.io/<upstreamNamespace>

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

property upstream_username¶

Gets the upstream_username of this CreateContainerRepositoryDetails. The upstream registry username for a pull-through cache repository. Required when repositoryType is PULL_THROUGH.

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