DataIntegrationClientCompositeOperations¶
-
class
oci.data_integration.
DataIntegrationClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
DataIntegrationClient
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 DataIntegrationClientCompositeOperations object
Parameters: client (DataIntegrationClient) – The service client which will be wrapped by this object
-
change_compartment_and_wait_for_state
(workspace_id, change_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- change_compartment_details (oci.data_integration.models.ChangeCompartmentDetails) – (required) The information needed to move a workspace to a specified compartment.
- 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_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
-
change_dis_application_compartment_and_wait_for_state
(workspace_id, dis_application_id, change_dis_application_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_dis_application_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- dis_application_id (str) – (required) The OCID of the DIS Application.
- change_dis_application_compartment_details (oci.data_integration.models.ChangeDisApplicationCompartmentDetails) – (required) The information needed to move a DIS Application to a specified compartment.
- 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_dis_application_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_application_and_wait_for_state
(workspace_id, create_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_application()
and waits for theApplication
acted upon to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- create_application_details (oci.data_integration.models.CreateApplicationDetails) – (required) The details needed to create an application.
- 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_application()
- 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_copy_object_request_and_wait_for_state
(workspace_id, create_copy_object_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_copy_object_request()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- create_copy_object_request_details (oci.data_integration.models.CreateCopyObjectRequestDetails) – (required) The details needed to copy metadata object.
- 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_copy_object_request()
- 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_dis_application_and_wait_for_state
(workspace_id, create_dis_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_dis_application()
and waits for theDisApplication
acted upon to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- create_dis_application_details (oci.data_integration.models.CreateDisApplicationDetails) – (required) The details needed to create a DIS application.
- 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_dis_application()
- 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_export_request_and_wait_for_state
(workspace_id, create_export_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_export_request()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- create_export_request_details (oci.data_integration.models.CreateExportRequestDetails) – (required) The details needed to export metadata object.
- 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_export_request()
- 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_import_request_and_wait_for_state
(workspace_id, create_import_request_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_import_request()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- create_import_request_details (oci.data_integration.models.CreateImportRequestDetails) – (required) The details needed to import metadata object.
- 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_import_request()
- 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_workspace_and_wait_for_state
(create_workspace_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_workspace()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_workspace_details (oci.data_integration.models.CreateWorkspaceDetails) – (required) The information needed to create a new Data Integration workspace.
- 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_workspace()
- 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_workspace_and_wait_for_state
(workspace_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_workspace()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- 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_workspace()
- 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_workspace_and_wait_for_state
(workspace_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_workspace()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- 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_workspace()
- 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_workspace_and_wait_for_state
(workspace_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_workspace()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- 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_workspace()
- 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_application_and_wait_for_state
(workspace_id, application_key, update_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_application()
and waits for theApplication
acted upon to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- application_key (str) – (required) The application key.
- update_application_details (oci.data_integration.models.UpdateApplicationDetails) – (required) The details needed to update an application.
- 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_application()
- 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_dis_application_and_wait_for_state
(workspace_id, dis_application_id, update_dis_application_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_dis_application()
and waits for theDisApplication
acted upon to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- dis_application_id (str) – (required) The OCID of the DIS Application.
- update_dis_application_details (oci.data_integration.models.UpdateDisApplicationDetails) – (required) The details needed to update an application.
- 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_dis_application()
- 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_workspace_and_wait_for_state
(workspace_id, update_workspace_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_workspace()
and waits for theWorkRequest
to enter the given state(s).Parameters: - workspace_id (str) – (required) The workspace ID.
- update_workspace_details (oci.data_integration.models.UpdateWorkspaceDetails) – (required) The information needed to update the workspace.
- 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_workspace()
- 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
-