ManagementClientCompositeOperations

class oci.oda.ManagementClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ManagementClient 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 ManagementClientCompositeOperations object
create_authentication_provider_and_wait_for_state(…) Calls create_authentication_provider() and waits for the AuthenticationProvider acted upon to enter the given state(s).
create_digital_assistant_and_wait_for_state(…) Calls create_digital_assistant() and waits for the WorkRequest to enter the given state(s).
create_skill_and_wait_for_state(…[, …]) Calls create_skill() and waits for the WorkRequest to enter the given state(s).
create_skill_parameter_and_wait_for_state(…) Calls create_skill_parameter() and waits for the SkillParameter acted upon to enter the given state(s).
create_translator_and_wait_for_state(…[, …]) Calls create_translator() and waits for the Translator acted upon to enter the given state(s).
export_digital_assistant_and_wait_for_state(…) Calls export_digital_assistant() and waits for the WorkRequest to enter the given state(s).
export_skill_and_wait_for_state(…[, …]) Calls export_skill() and waits for the WorkRequest to enter the given state(s).
import_bot_and_wait_for_state(…[, …]) Calls import_bot() and waits for the WorkRequest to enter the given state(s).
publish_digital_assistant_and_wait_for_state(…) Calls publish_digital_assistant() and waits for the DigitalAssistant acted upon to enter the given state(s).
publish_skill_and_wait_for_state(…[, …]) Calls publish_skill() and waits for the Skill acted upon to enter the given state(s).
start_channel_and_wait_for_state(…[, …]) Calls start_channel() and waits for the Channel acted upon to enter the given state(s).
stop_channel_and_wait_for_state(…[, …]) Calls stop_channel() and waits for the Channel acted upon to enter the given state(s).
update_authentication_provider_and_wait_for_state(…) Calls update_authentication_provider() and waits for the AuthenticationProvider acted upon to enter the given state(s).
update_channel_and_wait_for_state(…[, …]) Calls update_channel() and waits for the Channel acted upon to enter the given state(s).
update_digital_assistant_and_wait_for_state(…) Calls update_digital_assistant() and waits for the DigitalAssistant acted upon to enter the given state(s).
update_digital_assistant_parameter_and_wait_for_state(…) Calls update_digital_assistant_parameter() and waits for the DigitalAssistantParameter acted upon to enter the given state(s).
update_skill_and_wait_for_state(…[, …]) Calls update_skill() and waits for the Skill acted upon to enter the given state(s).
update_skill_parameter_and_wait_for_state(…) Calls update_skill_parameter() and waits for the SkillParameter acted upon to enter the given state(s).
update_translator_and_wait_for_state(…[, …]) Calls update_translator() and waits for the Translator acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new ManagementClientCompositeOperations object

Parameters:client (ManagementClient) – The service client which will be wrapped by this object
create_authentication_provider_and_wait_for_state(oda_instance_id, create_authentication_provider_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_authentication_provider() and waits for the AuthenticationProvider acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_authentication_provider_details (oci.oda.models.CreateAuthenticationProviderDetails) – (required) Property values required to create the new Authentication Provider.
  • 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_authentication_provider()
  • 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_digital_assistant_and_wait_for_state(oda_instance_id, create_digital_assistant_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_digital_assistant_details (oci.oda.models.CreateDigitalAssistantDetails) – (required) Property values for creating the new Digital Assistant.
  • 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_digital_assistant()
  • 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_skill_and_wait_for_state(oda_instance_id, create_skill_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_skill_details (oci.oda.models.CreateSkillDetails) – (required) Property values for creating the Skill.
  • 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_skill()
  • 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_skill_parameter_and_wait_for_state(oda_instance_id, skill_id, create_skill_parameter_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_skill_parameter() and waits for the SkillParameter acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • create_skill_parameter_details (oci.oda.models.CreateSkillParameterDetails) – (required) Property values for creating the new Skill Parameter.
  • 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_skill_parameter()
  • 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_translator_and_wait_for_state(oda_instance_id, create_translator_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_translator() and waits for the Translator acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • create_translator_details (oci.oda.models.CreateTranslatorDetails) – (required) Property values to create the new Translator.
  • 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_translator()
  • 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
export_digital_assistant_and_wait_for_state(oda_instance_id, digital_assistant_id, export_digital_assistant_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • export_digital_assistant_details (oci.oda.models.ExportDigitalAssistantDetails) – (required) Where in Object Storage to export the Digital Assistant to.
  • 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 export_digital_assistant()
  • 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
export_skill_and_wait_for_state(oda_instance_id, skill_id, export_skill_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • export_skill_details (oci.oda.models.ExportSkillDetails) – (required) Where in Object Storage to export the Skill to.
  • 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 export_skill()
  • 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
import_bot_and_wait_for_state(oda_instance_id, import_bot_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • import_bot_details (oci.oda.models.ImportBotDetails) – (required) Properties for where in Object Storage to import the Bot archive from.
  • 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 import_bot()
  • 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
publish_digital_assistant_and_wait_for_state(oda_instance_id, digital_assistant_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls publish_digital_assistant() and waits for the DigitalAssistant acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • 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 publish_digital_assistant()
  • 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
publish_skill_and_wait_for_state(oda_instance_id, skill_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls publish_skill() and waits for the Skill acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • 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 publish_skill()
  • 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
start_channel_and_wait_for_state(oda_instance_id, channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls start_channel() and waits for the Channel acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • 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 start_channel()
  • 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
stop_channel_and_wait_for_state(oda_instance_id, channel_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls stop_channel() and waits for the Channel acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • 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 stop_channel()
  • 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_authentication_provider_and_wait_for_state(oda_instance_id, authentication_provider_id, update_authentication_provider_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_authentication_provider() and waits for the AuthenticationProvider acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • authentication_provider_id (str) – (required) Unique Authentication Provider identifier.
  • update_authentication_provider_details (oci.oda.models.UpdateAuthenticationProviderDetails) – (required) Property values to update the Authentication Provider.
  • 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_authentication_provider()
  • 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_channel_and_wait_for_state(oda_instance_id, channel_id, update_channel_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_channel() and waits for the Channel acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • channel_id (str) – (required) Unique Channel identifier.
  • update_channel_details (oci.oda.models.UpdateChannelDetails) – (required) Property values to update the Channel.
  • 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_channel()
  • 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_digital_assistant_and_wait_for_state(oda_instance_id, digital_assistant_id, update_digital_assistant_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_digital_assistant() and waits for the DigitalAssistant acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • update_digital_assistant_details (oci.oda.models.UpdateDigitalAssistantDetails) – (required) Property values to update the Digital Assistant.
  • 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_digital_assistant()
  • 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_digital_assistant_parameter_and_wait_for_state(oda_instance_id, digital_assistant_id, parameter_name, update_digital_assistant_parameter_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_digital_assistant_parameter() and waits for the DigitalAssistantParameter acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • digital_assistant_id (str) – (required) Unique Digital Assistant identifier.
  • parameter_name (str) – (required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.
  • update_digital_assistant_parameter_details (oci.oda.models.UpdateDigitalAssistantParameterDetails) – (required) Property values to update the Digital Assistant Parameter.
  • 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_digital_assistant_parameter()
  • 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_skill_and_wait_for_state(oda_instance_id, skill_id, update_skill_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_skill() and waits for the Skill acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • update_skill_details (oci.oda.models.UpdateSkillDetails) – (required) Property values to update the Skill.
  • 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_skill()
  • 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_skill_parameter_and_wait_for_state(oda_instance_id, skill_id, parameter_name, update_skill_parameter_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_skill_parameter() and waits for the SkillParameter acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • skill_id (str) – (required) Unique Skill identifier.
  • parameter_name (str) – (required) The name of a Skill Parameter.
  • update_skill_parameter_details (oci.oda.models.UpdateSkillParameterDetails) – (required) Property values to update the Skill Parameter.
  • 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_skill_parameter()
  • 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_translator_and_wait_for_state(oda_instance_id, translator_id, update_translator_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_translator() and waits for the Translator acted upon to enter the given state(s).

Parameters:
  • oda_instance_id (str) – (required) Unique Digital Assistant instance identifier.
  • translator_id (str) – (required) Unique Translator identifier.
  • update_translator_details (oci.oda.models.UpdateTranslatorDetails) – (required) Property values to update the Translator.
  • 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_translator()
  • 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