ArtifactsClientCompositeOperations¶
- class oci.artifacts.ArtifactsClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
ArtifactsClientand offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods:
__init__(client, **kwargs)Creates a new ArtifactsClientCompositeOperations object
Calls
create_container_image_signature()and waits for theContainerImageSignatureacted upon to enter the given state(s).Calls
create_container_repository()and waits for theContainerRepositoryacted upon to enter the given state(s).create_repository_and_wait_for_state(...[, ...])Calls
create_repository()and waits for theRepositoryacted upon to enter the given state(s).Calls
delete_container_image()and waits for theContainerImageacted upon to enter the given state(s).Calls
delete_container_image_signature()and waits for theContainerImageSignatureacted upon to enter the given state(s).Calls
delete_container_repository()and waits for theContainerRepositoryacted upon to enter the given state(s).Calls
delete_generic_artifact()and waits for theGenericArtifactacted upon to enter the given state(s).delete_repository_and_wait_for_state(...[, ...])Calls
delete_repository()and waits for theRepositoryacted upon to enter the given state(s).Calls
remove_container_version()and waits for theContainerImageacted upon to enter the given state(s).Calls
restore_container_image()and waits for theContainerImageacted upon to enter the given state(s).Calls
update_container_image()and waits for theContainerImageacted upon to enter the given state(s).Calls
update_container_image_signature()and waits for theContainerImageSignatureacted upon to enter the given state(s).Calls
update_container_repository()and waits for theContainerRepositoryacted upon to enter the given state(s).Calls
update_generic_artifact()and waits for theGenericArtifactacted upon to enter the given state(s).update_repository_and_wait_for_state(...[, ...])Calls
update_repository()and waits for theRepositoryacted upon to enter the given state(s).- __init__(client, **kwargs)¶
Creates a new ArtifactsClientCompositeOperations object
- Parameters
client (ArtifactsClient) – The service client which will be wrapped by this object
- create_container_image_signature_and_wait_for_state(create_container_image_signature_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_container_image_signature()and waits for theContainerImageSignatureacted upon to enter the given state(s).- Parameters
create_container_image_signature_details (oci.artifacts.models.CreateContainerImageSignatureDetails) – (required) Upload container image signature details
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_container_image_signature()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_container_repository_and_wait_for_state(create_container_repository_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_container_repository()and waits for theContainerRepositoryacted upon to enter the given state(s).- Parameters
create_container_repository_details (oci.artifacts.models.CreateContainerRepositoryDetails) – (required) Create container repository details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_container_repository()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_repository_and_wait_for_state(create_repository_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_repository()and waits for theRepositoryacted upon to enter the given state(s).- Parameters
create_repository_details (oci.artifacts.models.CreateRepositoryDetails) – (required) Creates a new repository for storing artifacts.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_repository()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_container_image_and_wait_for_state(image_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_container_image()and waits for theContainerImageacted upon to enter the given state(s).- Parameters
image_id (str) –
(required) The OCID of the container image.
Example: ocid1.containerimage.oc1..exampleuniqueID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_container_image()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_container_image_signature_and_wait_for_state(image_signature_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_container_image_signature()and waits for theContainerImageSignatureacted upon to enter the given state(s).- Parameters
image_signature_id (str) –
(required) The OCID of the container image signature.
Example: ocid1.containersignature.oc1..exampleuniqueID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_container_image_signature()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_container_repository_and_wait_for_state(repository_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_container_repository()and waits for theContainerRepositoryacted upon to enter the given state(s).- Parameters
repository_id (str) –
(required) The OCID of the container repository.
Example: ocid1.containerrepo.oc1..exampleuniqueID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_container_repository()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_generic_artifact_and_wait_for_state(artifact_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_generic_artifact()and waits for theGenericArtifactacted upon to enter the given state(s).- Parameters
artifact_id (str) –
(required) The OCID of the artifact.
Example: ocid1.genericartifact.oc1..exampleuniqueID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_generic_artifact()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_repository_and_wait_for_state(repository_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_repository()and waits for theRepositoryacted upon to enter the given state(s).- Parameters
repository_id (str) –
(required) The OCID of the repository.
Example: ocid1.artifactrepository.oc1..exampleuniqueID
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_repository()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- remove_container_version_and_wait_for_state(image_id, remove_container_version_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
remove_container_version()and waits for theContainerImageacted upon to enter the given state(s).- Parameters
image_id (str) –
(required) The OCID of the container image.
Example: ocid1.containerimage.oc1..exampleuniqueID
remove_container_version_details (oci.artifacts.models.RemoveContainerVersionDetails) – (required) Remove version details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
remove_container_version()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- restore_container_image_and_wait_for_state(image_id, restore_container_image_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
restore_container_image()and waits for theContainerImageacted upon to enter the given state(s).- Parameters
image_id (str) –
(required) The OCID of the container image.
Example: ocid1.containerimage.oc1..exampleuniqueID
restore_container_image_details (oci.artifacts.models.RestoreContainerImageDetails) – (required) Restore container image details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
restore_container_image()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_container_image_and_wait_for_state(image_id, update_container_image_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_container_image()and waits for theContainerImageacted upon to enter the given state(s).- Parameters
image_id (str) –
(required) The OCID of the container image.
Example: ocid1.containerimage.oc1..exampleuniqueID
update_container_image_details (oci.artifacts.models.UpdateContainerImageDetails) – (required) Update container image details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_container_image()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_container_image_signature_and_wait_for_state(image_signature_id, update_container_image_signature_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_container_image_signature()and waits for theContainerImageSignatureacted upon to enter the given state(s).- Parameters
image_signature_id (str) –
(required) The OCID of the container image signature.
Example: ocid1.containersignature.oc1..exampleuniqueID
update_container_image_signature_details (oci.artifacts.models.UpdateContainerImageSignatureDetails) – (required) Update container image signature details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_container_image_signature()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_container_repository_and_wait_for_state(repository_id, update_container_repository_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_container_repository()and waits for theContainerRepositoryacted upon to enter the given state(s).- Parameters
repository_id (str) –
(required) The OCID of the container repository.
Example: ocid1.containerrepo.oc1..exampleuniqueID
update_container_repository_details (oci.artifacts.models.UpdateContainerRepositoryDetails) – (required) Update container repository details.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_container_repository()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_generic_artifact_and_wait_for_state(artifact_id, update_generic_artifact_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_generic_artifact()and waits for theGenericArtifactacted upon to enter the given state(s).- Parameters
artifact_id (str) –
(required) The OCID of the artifact.
Example: ocid1.genericartifact.oc1..exampleuniqueID
update_generic_artifact_details (oci.artifacts.models.UpdateGenericArtifactDetails) –
(required) Updates the artifact with the specified OCID. You can only update the tags of an artifact.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_generic_artifact()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_repository_and_wait_for_state(repository_id, update_repository_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_repository()and waits for theRepositoryacted upon to enter the given state(s).- Parameters
repository_id (str) –
(required) The OCID of the repository.
Example: ocid1.artifactrepository.oc1..exampleuniqueID
update_repository_details (oci.artifacts.models.UpdateRepositoryDetails) – (required) Updates the properties of a repository.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_repository()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait