ShardedDatabaseServiceClientCompositeOperations

class oci.globally_distributed_database.ShardedDatabaseServiceClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ShardedDatabaseServiceClient 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 ShardedDatabaseServiceClientCompositeOperations object
change_private_endpoint_compartment_and_wait_for_state(…)	Calls change_private_endpoint_compartment() and waits for the WorkRequest to enter the given state(s).
change_sharded_database_compartment_and_wait_for_state(…)	Calls change_sharded_database_compartment() and waits for the WorkRequest to enter the given state(s).
configure_sharded_database_gsms_and_wait_for_state(…)	Calls configure_sharded_database_gsms() and waits for the WorkRequest to enter the given state(s).
configure_sharding_and_wait_for_state(…[, …])	Calls configure_sharding() and waits for the WorkRequest to enter the given state(s).
create_private_endpoint_and_wait_for_state(…)	Calls create_private_endpoint() and waits for the WorkRequest to enter the given state(s).
create_sharded_database_and_wait_for_state(…)	Calls create_sharded_database() and waits for the WorkRequest to enter the given state(s).
delete_private_endpoint_and_wait_for_state(…)	Calls delete_private_endpoint() and waits for the WorkRequest to enter the given state(s).
delete_sharded_database_and_wait_for_state(…)	Calls delete_sharded_database() and waits for the WorkRequest to enter the given state(s).
generate_gsm_certificate_signing_request_and_wait_for_state(…)	Calls generate_gsm_certificate_signing_request() and waits for the WorkRequest to enter the given state(s).
patch_sharded_database_and_wait_for_state(…)	Calls patch_sharded_database() and waits for the WorkRequest to enter the given state(s).
reinstate_proxy_instance_and_wait_for_state(…)	Calls reinstate_proxy_instance() and waits for the WorkRequest to enter the given state(s).
start_sharded_database_and_wait_for_state(…)	Calls start_sharded_database() and waits for the WorkRequest to enter the given state(s).
stop_sharded_database_and_wait_for_state(…)	Calls stop_sharded_database() and waits for the WorkRequest to enter the given state(s).
update_private_endpoint_and_wait_for_state(…)	Calls update_private_endpoint() and waits for the PrivateEndpoint acted upon to enter the given state(s).
update_sharded_database_and_wait_for_state(…)	Calls update_sharded_database() and waits for the ShardedDatabase acted upon to enter the given state(s).
upload_signed_certificate_and_generate_wallet_and_wait_for_state(…)	Calls upload_signed_certificate_and_generate_wallet() and waits for the WorkRequest to enter the given state(s).
validate_network_and_wait_for_state(…[, …])	Calls validate_network() and waits for the WorkRequest to enter the given state(s).

__init__(client, **kwargs)

Creates a new ShardedDatabaseServiceClientCompositeOperations object

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

change_private_endpoint_compartment_and_wait_for_state(change_private_endpoint_compartment_details, private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• change_private_endpoint_compartment_details (oci.globally_distributed_database.models.ChangePrivateEndpointCompartmentDetails) – (required) Request to move the private endpoint to a different compartment.
• private_endpoint_id (str) – (required) Oracle Sharded Database PrivateEndpoint 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_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

change_sharded_database_compartment_and_wait_for_state(change_sharded_database_compartment_details, sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• change_sharded_database_compartment_details (oci.globally_distributed_database.models.ChangeShardedDatabaseCompartmentDetails) – (required) Request to move the sharded database to a different compartment.
• sharded_database_id (str) – (required) Sharded 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_sharded_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

configure_sharded_database_gsms_and_wait_for_state(configure_sharded_database_gsms_details, sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• configure_sharded_database_gsms_details (oci.globally_distributed_database.models.ConfigureShardedDatabaseGsmsDetails) – (required) Details to configure the new GSM instances for the sharded database.
• sharded_database_id (str) – (required) Sharded 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_sharded_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_sharding_and_wait_for_state(sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded 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_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_private_endpoint_and_wait_for_state(create_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_private_endpoint_details (oci.globally_distributed_database.models.CreatePrivateEndpointDetails) – (required) Details of PrivateEndpoint 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_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_sharded_database_and_wait_for_state(create_sharded_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• create_sharded_database_details (oci.globally_distributed_database.models.CreateShardedDatabaseDetails) – (required) Details of Sharded 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_sharded_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_private_endpoint_and_wait_for_state(private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• private_endpoint_id (str) – (required) Oracle Sharded Database PrivateEndpoint 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_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_sharded_database_and_wait_for_state(sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded 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_sharded_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_gsm_certificate_signing_request_and_wait_for_state(sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded 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 generate_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_sharded_database_and_wait_for_state(sharded_database_id, patch_sharded_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded Database identifier
• patch_sharded_database_details (oci.globally_distributed_database.models.PatchShardedDatabaseDetails) – (required) The payload containing instructions to patch the sharded 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_sharded_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

reinstate_proxy_instance_and_wait_for_state(private_endpoint_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• private_endpoint_id (str) – (required) Oracle Sharded Database PrivateEndpoint 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 reinstate_proxy_instance()
• 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_sharded_database_and_wait_for_state(sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded 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_sharded_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_sharded_database_and_wait_for_state(sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded 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_sharded_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_private_endpoint_and_wait_for_state(private_endpoint_id, update_private_endpoint_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_private_endpoint() and waits for the PrivateEndpoint acted upon to enter the given state(s).

Parameters:

• private_endpoint_id (str) – (required) Oracle Sharded Database PrivateEndpoint identifier
• update_private_endpoint_details (oci.globally_distributed_database.models.UpdatePrivateEndpointDetails) – (required) The configuration of private endpoint 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_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_sharded_database_and_wait_for_state(sharded_database_id, update_sharded_database_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_sharded_database() and waits for the ShardedDatabase acted upon to enter the given state(s).

Parameters:

• sharded_database_id (str) – (required) Sharded Database identifier
• update_sharded_database_details (oci.globally_distributed_database.models.UpdateShardedDatabaseDetails) – (required) The configuration of Sharded 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_sharded_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_signed_certificate_and_generate_wallet_and_wait_for_state(sharded_database_id, upload_signed_certificate_and_generate_wallet_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded Database identifier
• upload_signed_certificate_and_generate_wallet_details (oci.globally_distributed_database.models.UploadSignedCertificateAndGenerateWalletDetails) – (required) Details required to upload the CA signed certificates to GSM instances of sharded 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_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_network_and_wait_for_state(sharded_database_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:

• sharded_database_id (str) – (required) Sharded 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_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