ResourceManagerClientCompositeOperations

class oci.resource_manager.ResourceManagerClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ResourceManagerClient 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 functionality

Methods

__init__(client, **kwargs) Creates a new ResourceManagerClientCompositeOperations object
cancel_job_and_wait_for_state(job_id[, …]) Calls cancel_job() and waits for the Job acted upon to enter the given state(s).
change_stack_compartment_and_wait_for_state(…) Calls change_stack_compartment() and waits for the WorkRequest to enter the given state(s).
create_job_and_wait_for_state(create_job_details) Calls create_job() and waits for the Job acted upon to enter the given state(s).
create_stack_and_wait_for_state(…[, …]) Calls create_stack() and waits for the Stack acted upon to enter the given state(s).
delete_stack_and_wait_for_state(stack_id[, …]) Calls delete_stack() and waits for the Stack acted upon to enter the given state(s).
detect_stack_drift_and_wait_for_state(stack_id) Calls detect_stack_drift() and waits for the WorkRequest to enter the given state(s).
update_job_and_wait_for_state(job_id, …[, …]) Calls update_job() and waits for the Job acted upon to enter the given state(s).
update_stack_and_wait_for_state(stack_id, …) Calls update_stack() and waits for the Stack acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new ResourceManagerClientCompositeOperations object

Parameters:client (ResourceManagerClient) – The service client which will be wrapped by this object
cancel_job_and_wait_for_state(job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls cancel_job() and waits for the Job acted upon to enter the given state(s).

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • 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 cancel_job()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
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 the WorkRequest to enter the given state(s).

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • change_stack_compartment_details (ChangeStackCompartmentDetails) – (required) Defines the properties of changeStackCompartment operation.
  • 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 pass max_interval_seconds or max_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
create_job_and_wait_for_state(create_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_job() and waits for the Job acted upon to enter the given state(s).

Parameters:
  • create_job_details (CreateJobDetails) – (required) The properties for a request to create a job.
  • 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_job()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
create_stack_and_wait_for_state(create_stack_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_stack() and waits for the Stack acted upon to enter the given state(s).

Parameters:
  • create_stack_details (CreateStackDetails) – (required) The properties for creating a stack.
  • 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_stack()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_stack_and_wait_for_state(stack_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_stack() and waits for the Stack acted upon to 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 lifecycle_state
  • 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 pass max_interval_seconds or max_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
detect_stack_drift_and_wait_for_state(stack_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls detect_stack_drift() and waits for the WorkRequest to 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 detect_stack_drift()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_job_and_wait_for_state(job_id, update_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_job() and waits for the Job acted upon to enter the given state(s).

Parameters:
  • job_id (str) –

    (required) The OCID of the job.

  • update_job_details (UpdateJobDetails) – (required) Updates properties for the specified job.
  • 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_job()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_stack_and_wait_for_state(stack_id, update_stack_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_stack() and waits for the Stack acted upon to enter the given state(s).

Parameters:
  • stack_id (str) –

    (required) The OCID of the stack.

  • update_stack_details (UpdateStackDetails) – (required) Updated information provided for the stack.
  • 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_stack()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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