OdaClientCompositeOperations¶
-
class
oci.oda.
OdaClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
OdaClient
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 OdaClientCompositeOperations object
Parameters: client (OdaClient) – The service client which will be wrapped by this object
-
change_oda_instance_compartment_and_wait_for_state
(oda_instance_id, change_oda_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_oda_instance_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- change_oda_instance_compartment_details (oci.oda.models.ChangeOdaInstanceCompartmentDetails) – (required) The compartment to which the Digital Assistant instance should be moved.
- 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_oda_instance_compartment()
- 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
-
create_oda_instance_and_wait_for_state
(create_oda_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_oda_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_oda_instance_details (oci.oda.models.CreateOdaInstanceDetails) – (required) Details for the new Digital Assistant instance.
- 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_oda_instance()
- 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
-
create_oda_instance_attachment_and_wait_for_state
(oda_instance_id, create_oda_instance_attachment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_oda_instance_attachment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- create_oda_instance_attachment_details (oci.oda.models.CreateOdaInstanceAttachmentDetails) – (required) Details for the new Digital Assistant instance attachment.
- 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_oda_instance_attachment()
- 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
-
delete_oda_instance_and_wait_for_state
(oda_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_oda_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- 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_oda_instance()
- 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
-
delete_oda_instance_attachment_and_wait_for_state
(oda_instance_id, attachment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_oda_instance_attachment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- attachment_id (str) – (required) Unique Digital Assistant instance attachment identifier.
- 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_oda_instance_attachment()
- 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
-
start_oda_instance_and_wait_for_state
(oda_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_oda_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- 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
start_oda_instance()
- 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
-
stop_oda_instance_and_wait_for_state
(oda_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_oda_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- 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
stop_oda_instance()
- 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
-
update_oda_instance_and_wait_for_state
(oda_instance_id, update_oda_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_oda_instance()
and waits for theOdaInstance
acted upon to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- update_oda_instance_details (oci.oda.models.UpdateOdaInstanceDetails) – (required) The information to update.
- 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_oda_instance()
- 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
-
update_oda_instance_attachment_and_wait_for_state
(oda_instance_id, attachment_id, update_oda_instance_attachment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_oda_instance_attachment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
- attachment_id (str) – (required) Unique Digital Assistant instance attachment identifier.
- update_oda_instance_attachment_details (oci.oda.models.UpdateOdaInstanceAttachmentDetails) – (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_oda_instance_attachment()
- 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
-