CcdCommitmentsClientCompositeOperations¶
-
class
oci.ccd_offers.CcdCommitmentsClientCompositeOperations(client, **kwargs)¶ This class provides a wrapper around
CcdCommitmentsClientand 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 CcdCommitmentsClientCompositeOperations object create_ccd_commitment_and_wait_for_state(…)Calls create_ccd_commitment()and waits for theCcdCommitmentacted upon to enter the given state(s).delete_ccd_commitment_and_wait_for_state(…)Calls delete_ccd_commitment()and waits for theCcdCommitmentacted upon to enter the given state(s).update_ccd_commitment_and_wait_for_state(…)Calls update_ccd_commitment()and waits for theCcdCommitmentacted upon to enter the given state(s).-
__init__(client, **kwargs)¶ Creates a new CcdCommitmentsClientCompositeOperations object
Parameters: client (CcdCommitmentsClient) – The service client which will be wrapped by this object
-
create_ccd_commitment_and_wait_for_state(ccd_offer_id, create_ccd_commitment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_ccd_commitment()and waits for theCcdCommitmentacted upon to enter the given state(s).Parameters: - ccd_offer_id (str) – (required) CCD offer OCID. If you’re trying to commit against the CCD offer, ensure that the CCD offer’s lifecycleDetails field value is Current or Scheduled. You can only sign up for a current or scheduled CCD offer, but not for any canceled, or ended CCD offer.
- create_ccd_commitment_details (oci.ccd_offers.models.CreateCcdCommitmentDetails) – (required) The create CCD commitment details model.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_ccd_commitment() - 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_ccd_commitment_and_wait_for_state(ccd_commitment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_ccd_commitment()and waits for theCcdCommitmentacted upon to enter the given state(s).Parameters: - ccd_commitment_id (str) – (required) CCD commitment OCID.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_ccd_commitment() - 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_ccd_commitment_and_wait_for_state(ccd_commitment_id, update_ccd_commitment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_ccd_commitment()and waits for theCcdCommitmentacted upon to enter the given state(s).Parameters: - ccd_commitment_id (str) – (required) CCD commitment OCID.
- update_ccd_commitment_details (oci.ccd_offers.models.UpdateCcdCommitmentDetails) – (required) The tag update details.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_ccd_commitment() - 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
-