ArtifactsClient¶

class oci.artifacts.ArtifactsClient(config, **kwargs)¶

Use the Artifacts and Container Images API to manage container images and non-container generic artifacts.

For container images such as Docker images, use the [ContainerImage](#/en/registry/latest/ContainerImage/) resource. Save the images in a [container repository](#/en/registry/latest/ContainerRepository).
For non-container generic artifacts or blobs, use the [GenericArtifact](#/en/registry/latest/GenericArtifact/) resource. Save the artifacts in an [artifact repository](#/en/registry/latest/Repository).
To upload and download non-container generic artifacts, instead of the Artifacts and Container Images API, use the Generic Artifacts Content API.

For more information, see the user guides for [Container Registry](/iaas/Content/Registry/home.htm) and [Artifact Registry](/iaas/Content/artifacts/home.htm).

Methods:

`__init__`(config, **kwargs)	Creates a new service client
`change_container_repository_compartment`(...)	Moves a container repository into a different compartment within the same tenancy.
`change_repository_compartment`(repository_id, ...)	Moves a repository into a different compartment within the same tenancy.
`create_container_image_signature`(...)	Upload a signature to an image.
`create_container_repository`(...)	Create a new empty container repository.
`create_repository`(create_repository_details, ...)	Creates a new repository for storing artifacts.
`delete_container_image`(image_id, **kwargs)	Delete a container image.
`delete_container_image_signature`(...)	Delete a container image signature.
`delete_container_repository`(repository_id, ...)	Delete container repository.
`delete_generic_artifact`(artifact_id, **kwargs)	Deletes an artifact with a specified `OCID`__.
`delete_generic_artifact_by_path`(...)	Deletes an artifact with a specified artifactPath and version.
`delete_repository`(repository_id, **kwargs)	Deletes the specified repository.
`get_container_configuration`(compartment_id, ...)	Get container configuration.
`get_container_image`(image_id, **kwargs)	Get container image metadata.
`get_container_image_signature`(...)	Get container image signature metadata.
`get_container_repository`(repository_id, **kwargs)	Get container repository.
`get_generic_artifact`(artifact_id, **kwargs)	Gets information about an artifact with a specified `OCID`__.
`get_generic_artifact_by_path`(repository_id, ...)	Gets information about an artifact with a specified artifactPath and version.
`get_repository`(repository_id, **kwargs)	Gets the specified repository's information.
`list_container_image_signatures`(...)	List container image signatures in an image.
`list_container_images`(compartment_id, **kwargs)	List container images in a compartment.
`list_container_repositories`(compartment_id, ...)	List container repositories in a compartment.
`list_generic_artifacts`(compartment_id, ...)	Lists artifacts in the specified repository.
`list_repositories`(compartment_id, **kwargs)	Lists repositories in the specified compartment.
`lookup_container_image_by_uri`(...)	Get container image metadata by URI.
`remove_container_version`(image_id, ...)	Remove version from container image.
`restore_container_image`(image_id, ...)	Restore a container image.
`update_container_configuration`(...)	Update container configuration.
`update_container_image`(image_id, ...)	Modify the properties of a container image.
`update_container_image_signature`(...)	Modify the properties of a container image signature.
`update_container_repository`(repository_id, ...)	Modify the properties of a container repository.
`update_generic_artifact`(artifact_id, ...)	Updates the artifact with the specified `OCID`__.
`update_generic_artifact_by_path`(...)	Updates an artifact with a specified artifactPath and version.
`update_repository`(repository_id, ...)	Updates the properties of a repository.

__init__(config, **kwargs)¶

Creates a new service client

Parameters

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
enable_strict_url_encoding – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this client should enable strict url encoding in path params of a request. By default, the client will not enable strict url encoding

change_container_repository_compartment(repository_id, change_container_repository_compartment_details, **kwargs)¶

Moves a container repository into a different compartment within the same tenancy. For information about moving resources between compartments, see `Moving Resources to a Different Compartment`__.

Parameters

repository_id (str) –
(required) The `OCID`__ of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID
change_container_repository_compartment_details (oci.artifacts.models.ChangeContainerRepositoryCompartmentDetails) – (required) Change container repository compartment details.
if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
retry_strategy (obj) –
(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.
allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
enable_strict_url_encoding (bool) – (optional) enable_strict_url_encoding is a boolean to indicate whether or not this request should enable strict url encoding for path params. By default, strict url encoding for path params is disabled

Returns

A Response object with data of type None

Return type