GovernanceClientCompositeOperations¶
-
class
oci.tenant_manager_control_plane.
GovernanceClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
GovernanceClient
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 GovernanceClientCompositeOperations object add_governance_and_wait_for_state
(…[, …])Calls add_governance()
and waits for theWorkRequest
to enter the given state(s).remove_governance_and_wait_for_state
(…[, …])Calls remove_governance()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new GovernanceClientCompositeOperations object
Parameters: client (GovernanceClient) – The service client which will be wrapped by this object
-
add_governance_and_wait_for_state
(organization_id, organization_tenancy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
add_governance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - organization_id (str) – (required) OCID of the organization.
- organization_tenancy_id (str) – (required) OCID of tenancy that is opting in to governance rules.
- 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_governance()
- 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
-
remove_governance_and_wait_for_state
(organization_id, organization_tenancy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_governance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - organization_id (str) – (required) OCID of the organization.
- organization_tenancy_id (str) – (required) OCID of tenancy that is opting out of governance rules.
- 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
remove_governance()
- 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
-