DataSafeClientCompositeOperations

class oci.data_safe.DataSafeClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DataSafeClient 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 DataSafeClientCompositeOperations object
activate_target_database_and_wait_for_state(…) Calls activate_target_database() and waits for the WorkRequest to enter the given state(s).
change_data_safe_private_endpoint_compartment_and_wait_for_state(…) Calls change_data_safe_private_endpoint_compartment() and waits for the WorkRequest to enter the given state(s).
create_data_safe_private_endpoint_and_wait_for_state(…) Calls create_data_safe_private_endpoint() and waits for the WorkRequest to enter the given state(s).
create_on_prem_connector_and_wait_for_state(…) Calls create_on_prem_connector() and waits for the WorkRequest to enter the given state(s).
create_target_database_and_wait_for_state(…) Calls create_target_database() and waits for the WorkRequest to enter the given state(s).
deactivate_target_database_and_wait_for_state(…) Calls deactivate_target_database() and waits for the WorkRequest to enter the given state(s).
delete_data_safe_private_endpoint_and_wait_for_state(…) Calls delete_data_safe_private_endpoint() and waits for the WorkRequest to enter the given state(s).
delete_on_prem_connector_and_wait_for_state(…) Calls delete_on_prem_connector() and waits for the WorkRequest to enter the given state(s).
delete_target_database_and_wait_for_state(…) Calls delete_target_database() and waits for the WorkRequest to enter the given state(s).
enable_data_safe_configuration_and_wait_for_state(…) Calls enable_data_safe_configuration() and waits for the WorkRequest to enter the given state(s).
update_data_safe_private_endpoint_and_wait_for_state(…) Calls update_data_safe_private_endpoint() and waits for the WorkRequest to enter the given state(s).
update_on_prem_connector_and_wait_for_state(…) Calls update_on_prem_connector() and waits for the WorkRequest to enter the given state(s).
update_on_prem_connector_wallet_and_wait_for_state(…) Calls update_on_prem_connector_wallet() and waits for the WorkRequest to enter the given state(s).
update_target_database_and_wait_for_state(…) Calls update_target_database() and waits for the WorkRequest to enter the given state(s).
__init__(client, **kwargs)

Creates a new DataSafeClientCompositeOperations object

Parameters:client (DataSafeClient) – The service client which will be wrapped by this object
activate_target_database_and_wait_for_state(activate_target_database_details, target_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • activate_target_database_details (oci.data_safe.models.ActivateTargetDatabaseDetails) – (required) The details used to reactivate a target database in Data Safe.
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • 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 activate_target_database()
  • 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
change_data_safe_private_endpoint_compartment_and_wait_for_state(data_safe_private_endpoint_id, change_data_safe_private_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • change_data_safe_private_endpoint_compartment_details (oci.data_safe.models.ChangeDataSafePrivateEndpointCompartmentDetails) – (required) The details used to change the compartment of a Data Safe private endpoint.
  • 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_data_safe_private_endpoint_compartment()
  • 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_data_safe_private_endpoint_and_wait_for_state(create_data_safe_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_data_safe_private_endpoint_details (oci.data_safe.models.CreateDataSafePrivateEndpointDetails) – (required) Details to create a new private endpoint.
  • 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_data_safe_private_endpoint()
  • 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_on_prem_connector_and_wait_for_state(create_on_prem_connector_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_on_prem_connector_details (oci.data_safe.models.CreateOnPremConnectorDetails) – (required) The details used to create a new on-premises connector.
  • 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_on_prem_connector()
  • 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_target_database_and_wait_for_state(create_target_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_target_database_details (oci.data_safe.models.CreateTargetDatabaseDetails) – (required) Details of the target database.
  • 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_target_database()
  • 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
deactivate_target_database_and_wait_for_state(target_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • 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 deactivate_target_database()
  • 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_data_safe_private_endpoint_and_wait_for_state(data_safe_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • 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_data_safe_private_endpoint()
  • 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_on_prem_connector_and_wait_for_state(on_prem_connector_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • 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_on_prem_connector()
  • 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_target_database_and_wait_for_state(target_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • 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_target_database()
  • 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
enable_data_safe_configuration_and_wait_for_state(enable_data_safe_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • enable_data_safe_configuration_details (oci.data_safe.models.EnableDataSafeConfigurationDetails) – (required) The details used to enable Data Safe.
  • 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 enable_data_safe_configuration()
  • 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_data_safe_private_endpoint_and_wait_for_state(data_safe_private_endpoint_id, update_data_safe_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • data_safe_private_endpoint_id (str) – (required) The OCID of the private endpoint.
  • update_data_safe_private_endpoint_details (oci.data_safe.models.UpdateDataSafePrivateEndpointDetails) – (required) The details used to update a Data Safe private endpoint.
  • 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_data_safe_private_endpoint()
  • 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_on_prem_connector_and_wait_for_state(on_prem_connector_id, update_on_prem_connector_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • update_on_prem_connector_details (oci.data_safe.models.UpdateOnPremConnectorDetails) – (required) The details used to update a on-premises connector.
  • 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_on_prem_connector()
  • 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_on_prem_connector_wallet_and_wait_for_state(update_on_prem_connector_wallet_details, on_prem_connector_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • update_on_prem_connector_wallet_details (oci.data_safe.models.UpdateOnPremConnectorWalletDetails) – (required) The details used to update an on-premises connector’s wallet.
  • on_prem_connector_id (str) – (required) The OCID of the on-premises connector.
  • 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_on_prem_connector_wallet()
  • 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_target_database_and_wait_for_state(target_database_id, update_target_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • target_database_id (str) – (required) The OCID of the Data Safe target database.
  • update_target_database_details (oci.data_safe.models.UpdateTargetDatabaseDetails) – (required) Details used to update the target database in Data Safe.
  • 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_target_database()
  • 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