DatabaseToolsClientCompositeOperations¶
-
class
oci.database_tools.
DatabaseToolsClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
DatabaseToolsClient
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 DatabaseToolsClientCompositeOperations object
Parameters: client (DatabaseToolsClient) – The service client which will be wrapped by this object
-
add_database_tools_connection_lock_and_wait_for_state
(database_tools_connection_id, add_resource_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
add_database_tools_connection_lock()
and waits for theDatabaseToolsConnection
acted upon to enter the given state(s).Parameters: - database_tools_connection_id (str) –
(required) The OCID of a Database Tools connection.
- add_resource_lock_details (oci.database_tools.models.AddResourceLockDetails) – (required) AddResourceLockDetails body 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
add_database_tools_connection_lock()
- 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
- database_tools_connection_id (str) –
-
add_database_tools_private_endpoint_lock_and_wait_for_state
(database_tools_private_endpoint_id, add_resource_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
add_database_tools_private_endpoint_lock()
and waits for theDatabaseToolsPrivateEndpoint
acted upon to enter the given state(s).Parameters: - database_tools_private_endpoint_id (str) –
(required) The OCID of a Database Tools private endpoint.
- add_resource_lock_details (oci.database_tools.models.AddResourceLockDetails) – (required) AddResourceLockDetails body 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
add_database_tools_private_endpoint_lock()
- 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
- database_tools_private_endpoint_id (str) –
-
change_database_tools_connection_compartment_and_wait_for_state
(database_tools_connection_id, change_database_tools_connection_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_database_tools_connection_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_tools_connection_id (str) –
(required) The OCID of a Database Tools connection.
- change_database_tools_connection_compartment_details (oci.database_tools.models.ChangeDatabaseToolsConnectionCompartmentDetails) – (required) Request to change the compartment of the DatabaseToolsConnection.
- 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_database_tools_connection_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
- database_tools_connection_id (str) –
-
change_database_tools_private_endpoint_compartment_and_wait_for_state
(database_tools_private_endpoint_id, change_database_tools_private_endpoint_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_database_tools_private_endpoint_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_tools_private_endpoint_id (str) –
(required) The OCID of a Database Tools private endpoint.
- change_database_tools_private_endpoint_compartment_details (oci.database_tools.models.ChangeDatabaseToolsPrivateEndpointCompartmentDetails) – (required) Request to change the compartment of the DatabaseToolsPrivateEndpoint.
- 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_database_tools_private_endpoint_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
- database_tools_private_endpoint_id (str) –
-
create_database_tools_connection_and_wait_for_state
(create_database_tools_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_database_tools_connection()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_database_tools_connection_details (oci.database_tools.models.CreateDatabaseToolsConnectionDetails) – (required) Details for the new DatabaseToolsConnection.
- 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_database_tools_connection()
- 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_database_tools_private_endpoint_and_wait_for_state
(create_database_tools_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_database_tools_private_endpoint()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_database_tools_private_endpoint_details (oci.database_tools.models.CreateDatabaseToolsPrivateEndpointDetails) – (required) Details for the new DatabaseToolsPrivateEndpoint.
- 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_database_tools_private_endpoint()
- 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_database_tools_connection_and_wait_for_state
(database_tools_connection_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_database_tools_connection()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_tools_connection_id (str) –
(required) The OCID of a Database Tools connection.
- 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_database_tools_connection()
- 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
- database_tools_connection_id (str) –
-
delete_database_tools_private_endpoint_and_wait_for_state
(database_tools_private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_database_tools_private_endpoint()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_tools_private_endpoint_id (str) –
(required) The OCID of a Database Tools 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_database_tools_private_endpoint()
- 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
- database_tools_private_endpoint_id (str) –
-
remove_database_tools_connection_lock_and_wait_for_state
(database_tools_connection_id, remove_resource_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_database_tools_connection_lock()
and waits for theDatabaseToolsConnection
acted upon to enter the given state(s).Parameters: - database_tools_connection_id (str) –
(required) The OCID of a Database Tools connection.
- remove_resource_lock_details (oci.database_tools.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body 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
remove_database_tools_connection_lock()
- 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
- database_tools_connection_id (str) –
-
remove_database_tools_private_endpoint_lock_and_wait_for_state
(database_tools_private_endpoint_id, remove_resource_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_database_tools_private_endpoint_lock()
and waits for theDatabaseToolsPrivateEndpoint
acted upon to enter the given state(s).Parameters: - database_tools_private_endpoint_id (str) –
(required) The OCID of a Database Tools private endpoint.
- remove_resource_lock_details (oci.database_tools.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body 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
remove_database_tools_private_endpoint_lock()
- 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
- database_tools_private_endpoint_id (str) –
-
update_database_tools_connection_and_wait_for_state
(database_tools_connection_id, update_database_tools_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_database_tools_connection()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_tools_connection_id (str) –
(required) The OCID of a Database Tools connection.
- update_database_tools_connection_details (oci.database_tools.models.UpdateDatabaseToolsConnectionDetails) – (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_database_tools_connection()
- 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
- database_tools_connection_id (str) –
-
update_database_tools_private_endpoint_and_wait_for_state
(database_tools_private_endpoint_id, update_database_tools_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_database_tools_private_endpoint()
and waits for theWorkRequest
to enter the given state(s).Parameters: - database_tools_private_endpoint_id (str) –
(required) The OCID of a Database Tools private endpoint.
- update_database_tools_private_endpoint_details (oci.database_tools.models.UpdateDatabaseToolsPrivateEndpointDetails) – (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_database_tools_private_endpoint()
- 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
- database_tools_private_endpoint_id (str) –
-