DistributedDbServiceClientCompositeOperations

class oci.distributed_database.DistributedDbServiceClientCompositeOperations(client, **kwargs)

This class provides a wrapper around DistributedDbServiceClient 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 DistributedDbServiceClientCompositeOperations object
add_distributed_database_gds_control_node_and_wait_for_state(…)	Calls add_distributed_database_gds_control_node() and waits for the WorkRequest to enter the given state(s).
change_distributed_database_compartment_and_wait_for_state(…)	Calls change_distributed_database_compartment() and waits for the WorkRequest to enter the given state(s).
change_distributed_db_backup_config_and_wait_for_state(…)	Calls change_distributed_db_backup_config() and waits for the WorkRequest to enter the given state(s).
configure_distributed_database_gsms_and_wait_for_state(…)	Calls configure_distributed_database_gsms() and waits for the WorkRequest to enter the given state(s).
configure_distributed_database_sharding_and_wait_for_state(…)	Calls configure_distributed_database_sharding() and waits for the WorkRequest to enter the given state(s).
create_distributed_database_and_wait_for_state(…)	Calls create_distributed_database() and waits for the WorkRequest to enter the given state(s).
delete_distributed_database_and_wait_for_state(…)	Calls delete_distributed_database() and waits for the WorkRequest to enter the given state(s).
generate_distributed_database_gsm_certificate_signing_request_and_wait_for_state(…)	Calls generate_distributed_database_gsm_certificate_signing_request() and waits for the WorkRequest to enter the given state(s).
patch_distributed_database_and_wait_for_state(…)	Calls patch_distributed_database() and waits for the WorkRequest to enter the given state(s).
rotate_distributed_database_passwords_and_wait_for_state(…)	Calls rotate_distributed_database_passwords() and waits for the WorkRequest to enter the given state(s).
start_distributed_database_and_wait_for_state(…)	Calls start_distributed_database() and waits for the WorkRequest to enter the given state(s).
stop_distributed_database_and_wait_for_state(…)	Calls stop_distributed_database() and waits for the WorkRequest to enter the given state(s).
update_distributed_database_and_wait_for_state(…)	Calls update_distributed_database() and waits for the DistributedDatabase acted upon to enter the given state(s).
upload_distributed_database_signed_certificate_and_generate_wallet_and_wait_for_state(…)	Calls upload_distributed_database_signed_certificate_and_generate_wallet() and waits for the WorkRequest to enter the given state(s).
validate_distributed_database_network_and_wait_for_state(…)	Calls validate_distributed_database_network() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new DistributedDbServiceClientCompositeOperations object

Parameters:client (DistributedDbServiceClient) – The service client which will be wrapped by this object

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 the WorkRequest to 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 status
• operation_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 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_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 the WorkRequest to 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 status
• operation_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 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_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 the WorkRequest to 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 status
• operation_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 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

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 the WorkRequest to 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 status
• operation_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 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

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 the WorkRequest to 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 status
• operation_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 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_distributed_database_and_wait_for_state(create_distributed_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_distributed_database() and waits for the WorkRequest to 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 status
• operation_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 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_distributed_database_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_distributed_database() and waits for the WorkRequest to 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 status
• operation_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 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

generate_distributed_database_gsm_certificate_signing_request_and_wait_for_state(distributed_database_id, ca_bundle_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• distributed_database_id (str) – (required) Globally distributed database identifier
• ca_bundle_id (str) – (required) The ID of the Ca Bundle.
• 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 generate_distributed_database_gsm_certificate_signing_request()
• 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

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 the WorkRequest to 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 status
• operation_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 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

rotate_distributed_database_passwords_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls rotate_distributed_database_passwords() and waits for the WorkRequest to 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 status
• operation_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 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_distributed_database_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls start_distributed_database() and waits for the WorkRequest to 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 status
• operation_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 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_distributed_database_and_wait_for_state(distributed_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls stop_distributed_database() and waits for the WorkRequest to 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 status
• operation_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 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_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 the DistributedDatabase acted 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_state
• operation_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 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

upload_distributed_database_signed_certificate_and_generate_wallet_and_wait_for_state(distributed_database_id, upload_distributed_database_signed_certificate_and_generate_wallet_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• distributed_database_id (str) – (required) Globally distributed database identifier
• upload_distributed_database_signed_certificate_and_generate_wallet_details (oci.distributed_database.models.UploadDistributedDatabaseSignedCertificateAndGenerateWalletDetails) – (required) Details required to upload the CA signed certificates to GSM instances of Globally distributed database and generate the wallets.
• 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 upload_distributed_database_signed_certificate_and_generate_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

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 the WorkRequest to 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 status
• operation_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 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