SubscriptionClientCompositeOperations¶
-
class
oci.self.SubscriptionClientCompositeOperations(client, **kwargs)¶ This class provides a wrapper around
SubscriptionClientand 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 SubscriptionClientCompositeOperations object change_subscription_compartment_and_wait_for_state(…)Calls change_subscription_compartment()and waits for theWorkRequestto enter the given state(s).create_subscription_and_wait_for_state(…)Calls create_subscription()and waits for theWorkRequestto enter the given state(s).delete_subscription_and_wait_for_state(…)Calls delete_subscription()and waits for theWorkRequestto enter the given state(s).update_subscription_and_wait_for_state(…)Calls update_subscription()and waits for theWorkRequestto enter the given state(s).-
__init__(client, **kwargs)¶ Creates a new SubscriptionClientCompositeOperations object
Parameters: client (SubscriptionClient) – The service client which will be wrapped by this object
-
change_subscription_compartment_and_wait_for_state(subscription_id, change_subscription_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_subscription_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - subscription_id (str) – (required) The unique identifier for the subscription.
- change_subscription_compartment_details (oci.self.models.ChangeSubscriptionCompartmentDetails) – (required) The information to be updated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_subscription_compartment() - 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_subscription_and_wait_for_state(create_subscription_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_subscription()and waits for theWorkRequestto enter the given state(s).Parameters: - create_subscription_details (oci.self.models.CreateSubscriptionDetails) – (required) Details for the new Subscription.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_subscription() - 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_subscription_and_wait_for_state(subscription_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_subscription()and waits for theWorkRequestto enter the given state(s).Parameters: - subscription_id (str) – (required) The unique identifier for the subscription.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_subscription() - 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_subscription_and_wait_for_state(subscription_id, update_subscription_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_subscription()and waits for theWorkRequestto enter the given state(s).Parameters: - subscription_id (str) – (required) The unique identifier for the subscription.
- update_subscription_details (oci.self.models.UpdateSubscriptionDetails) – (required) The information to be updated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status - operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_subscription() - 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
-