OfferClientCompositeOperations¶
-
class
oci.marketplace_private_offer.
OfferClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
OfferClient
and 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 OfferClientCompositeOperations object create_offer_and_wait_for_state
(…[, …])Calls create_offer()
and waits for theOffer
acted upon to enter the given state(s).delete_offer_and_wait_for_state
(offer_id[, …])Calls delete_offer()
and waits for theOffer
acted upon to enter the given state(s).update_offer_and_wait_for_state
(offer_id, …)Calls update_offer()
and waits for theOffer
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new OfferClientCompositeOperations object
Parameters: client (OfferClient) – The service client which will be wrapped by this object
-
create_offer_and_wait_for_state
(create_offer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_offer()
and waits for theOffer
acted upon to enter the given state(s).Parameters: - create_offer_details (oci.marketplace_private_offer.models.CreateOfferDetails) – (required) Details for the new Offer.
- 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_offer()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_offer_and_wait_for_state
(offer_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_offer()
and waits for theOffer
acted upon to enter the given state(s).Parameters: - offer_id (str) – (required) unique Offer identifier
- 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_offer()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_offer_and_wait_for_state
(offer_id, update_offer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_offer()
and waits for theOffer
acted upon to enter the given state(s).Parameters: - offer_id (str) – (required) unique Offer identifier
- update_offer_details (oci.marketplace_private_offer.models.UpdateOfferDetails) – (required) The information to be updated.
- 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_offer()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-