DistributedDbServiceClientCompositeOperations¶
- class oci.distributed_database.DistributedDbServiceClientCompositeOperations(client, work_request_clients=None, **kwargs)¶
This class provides a wrapper around
DistributedDbServiceClientand 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, work_request_clients=None, **kwargs)¶
Creates a new DistributedDbServiceClientCompositeOperations object
- Parameters
client (DistributedDbServiceClient) – The service client which will be wrapped by this object
work_request_clients (dict) –
(optional) Service-local clients keyed by generated client class name, for example
{'WorkRequestClient': work_request_client}. By default, regional clients are created when needed using the wrapped client’s signer, endpoint and constructor options.Automatically created work-request clients are cached. Before each wait, their endpoint and signer are refreshed from the wrapped client; other client settings and HTTP session changes are not synchronized. Do not modify the wrapped client’s endpoint or signer while a wait is in progress.
Supply a client for non-regional endpoints or customized HTTP sessions. These clients are separate from the shared Work Requests service.
- add_distributed_database_gds_control_node_and_wait_for_state(distributed_database_id, add_distributed_database_gds_control_node_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
add_distributed_database_gds_control_node()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
add_distributed_database_gds_control_node_details (oci.distributed_database.models.AddDistributedDatabaseGdsControlNodeDetails) – (required) Details required to provision the new Global database services control(GDS CTL) node for the Distributed database.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
add_distributed_database_gds_control_node()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- change_distributed_database_compartment_and_wait_for_state(change_distributed_database_compartment_details, distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_distributed_database_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
change_distributed_database_compartment_details (oci.distributed_database.models.ChangeDistributedDatabaseCompartmentDetails) – (required) Request to move the Globally distributed database to a different compartment.
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_distributed_database_compartment()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- change_distributed_db_backup_config_and_wait_for_state(distributed_database_id, change_distributed_db_backup_config_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_distributed_db_backup_config()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
change_distributed_db_backup_config_details (oci.distributed_database.models.ChangeDistributedDbBackupConfigDetails) – (required) Details of the DistributedDbBackupConfig for the Globally distributed database.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
change_distributed_db_backup_config()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- configure_distributed_database_gsms_and_wait_for_state(configure_distributed_database_gsms_details, distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
configure_distributed_database_gsms()and waits for theWorkRequestto enter the given state(s).- Parameters
configure_distributed_database_gsms_details (oci.distributed_database.models.ConfigureDistributedDatabaseGsmsDetails) – (required) Details to configure the new GSM instances for the distributed database.
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
configure_distributed_database_gsms()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- configure_distributed_database_sharding_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
configure_distributed_database_sharding()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
configure_distributed_database_sharding()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_distributed_database_and_wait_for_state(create_distributed_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_distributed_database()and waits for theWorkRequestto enter the given state(s).- Parameters
create_distributed_database_details (oci.distributed_database.models.CreateDistributedDatabaseDetails) – (required) Details of the Globally distributed database to be created.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_distributed_database()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_distributed_database_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_distributed_database()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_distributed_database()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- move_distributed_database_replication_unit_and_wait_for_state(distributed_database_id, move_distributed_database_replication_unit_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
move_distributed_database_replication_unit()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
move_distributed_database_replication_unit_details (oci.distributed_database.models.MoveDistributedDatabaseReplicationUnitDetails) – (required) Details required to move the replication units from source shard to destination shard.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
move_distributed_database_replication_unit()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- patch_distributed_database_and_wait_for_state(distributed_database_id, patch_distributed_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
patch_distributed_database()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
patch_distributed_database_details (oci.distributed_database.models.PatchDistributedDatabaseDetails) – (required) The payload containing instructions to patch the Globally distributed database.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
patch_distributed_database()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- recreate_failed_distributed_database_resource_and_wait_for_state(distributed_database_id, resource_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
recreate_failed_distributed_database_resource()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
resource_name (str) – (required) Specify the name of the shard, catalog, or GSM.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
recreate_failed_distributed_database_resource()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- rotate_distributed_database_passwords_and_wait_for_state(distributed_database_id, rotate_distributed_database_passwords_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
rotate_distributed_database_passwords()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
rotate_distributed_database_passwords_details (oci.distributed_database.models.RotateDistributedDatabasePasswordsDetails) – (required) Details to rotate passwords for shards and catalogs in the Globally distributed database.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
rotate_distributed_database_passwords()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- scale_distributed_database_gsms_and_wait_for_state(scale_distributed_database_gsms_details, distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
scale_distributed_database_gsms()and waits for theWorkRequestto enter the given state(s).- Parameters
scale_distributed_database_gsms_details (oci.distributed_database.models.ScaleDistributedDatabaseGsmsDetails) – (required) Empty payload to scale GSM instances for the distributed database.
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
scale_distributed_database_gsms()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- start_distributed_database_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
start_distributed_database()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
start_distributed_database()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- stop_distributed_database_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
stop_distributed_database()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
stop_distributed_database()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_distributed_database_and_wait_for_state(distributed_database_id, update_distributed_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_distributed_database()and waits for theDistributedDatabaseacted upon to enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
update_distributed_database_details (oci.distributed_database.models.UpdateDistributedDatabaseDetails) – (required) The configuration of the Globally distributed database to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_distributed_database()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- validate_distributed_database_network_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
validate_distributed_database_network()and waits for theWorkRequestto enter the given state(s).- Parameters
distributed_database_id (str) – (required) Globally distributed database identifier.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
validate_distributed_database_network()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait