StackClientCompositeOperations¶
-
class
oci.dif.StackClientCompositeOperations(client, **kwargs)¶ This class provides a wrapper around
StackClientand 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 StackClientCompositeOperations object add_service_and_wait_for_state(stack_id, …)Calls add_service()and waits for theWorkRequestto enter the given state(s).change_stack_compartment_and_wait_for_state(…)Calls change_stack_compartment()and waits for theWorkRequestto enter the given state(s).create_stack_and_wait_for_state(…[, …])Calls create_stack()and waits for theWorkRequestto enter the given state(s).delete_stack_and_wait_for_state(stack_id[, …])Calls delete_stack()and waits for theWorkRequestto enter the given state(s).deploy_artifacts_and_wait_for_state(…[, …])Calls deploy_artifacts()and waits for theWorkRequestto enter the given state(s).update_stack_and_wait_for_state(stack_id, …)Calls update_stack()and waits for theWorkRequestto enter the given state(s).-
__init__(client, **kwargs)¶ Creates a new StackClientCompositeOperations object
Parameters: client (StackClient) – The service client which will be wrapped by this object
-
add_service_and_wait_for_state(stack_id, add_service_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
add_service()and waits for theWorkRequestto enter the given state(s).Parameters: - stack_id (str) –
(required) The OCID of the Stack.
- add_service_details (oci.dif.models.AddServiceDetails) – (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
add_service() - 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
- stack_id (str) –
-
change_stack_compartment_and_wait_for_state(stack_id, change_stack_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_stack_compartment()and waits for theWorkRequestto enter the given state(s).Parameters: - stack_id (str) –
(required) The OCID of the Stack.
- change_stack_compartment_details (oci.dif.models.ChangeStackCompartmentDetails) – (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_stack_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
- stack_id (str) –
-
create_stack_and_wait_for_state(create_stack_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_stack()and waits for theWorkRequestto enter the given state(s).Parameters: - create_stack_details (oci.dif.models.CreateStackDetails) – (required) Details for the new Stack.
- 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_stack() - 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_stack_and_wait_for_state(stack_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_stack()and waits for theWorkRequestto enter the given state(s).Parameters: - stack_id (str) –
(required) The OCID of the Stack.
- 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_stack() - 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
- stack_id (str) –
-
deploy_artifacts_and_wait_for_state(stack_id, deploy_artifacts_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
deploy_artifacts()and waits for theWorkRequestto enter the given state(s).Parameters: - stack_id (str) –
(required) The OCID of the Stack.
- deploy_artifacts_details (oci.dif.models.DeployArtifactsDetails) – (required) The artifact information to be deployed.
- 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
deploy_artifacts() - 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
- stack_id (str) –
-
update_stack_and_wait_for_state(stack_id, update_stack_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_stack()and waits for theWorkRequestto enter the given state(s).Parameters: - stack_id (str) –
(required) The OCID of the Stack.
- update_stack_details (oci.dif.models.UpdateStackDetails) – (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_stack() - 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
- stack_id (str) –
-