DomainClientCompositeOperations

class oci.tenant_manager_control_plane.DomainClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DomainClient 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 DomainClientCompositeOperations object
create_domain_and_wait_for_state(…[, …])	Calls create_domain() and waits for the WorkRequest to enter the given state(s).
delete_domain_and_wait_for_state(domain_id)	Calls delete_domain() and waits for the Domain acted upon to enter the given state(s).
update_domain_and_wait_for_state(domain_id, …)	Calls update_domain() and waits for the Domain acted upon to enter the given state(s).

__init__(client, **kwargs)

Creates a new DomainClientCompositeOperations object

Parameters:client (DomainClient) – The service client which will be wrapped by this object

create_domain_and_wait_for_state(create_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_domain() and waits for the WorkRequest to enter the given state(s).

Parameters:

• create_domain_details (oci.tenant_manager_control_plane.models.CreateDomainDetails) – (required) Parameters for domain creation.
• 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_domain()
• 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_domain_and_wait_for_state(domain_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_domain() and waits for the Domain acted upon to enter the given state(s).

Parameters:

• domain_id (str) – (required) The domain 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_domain()
• 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_domain_and_wait_for_state(domain_id, update_domain_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_domain() and waits for the Domain acted upon to enter the given state(s).

Parameters:

• domain_id (str) – (required) The domain OCID.
• update_domain_details (oci.tenant_manager_control_plane.models.UpdateDomainDetails) – (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_domain()
• 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