NosqlClientCompositeOperations¶
- class oci.nosql.NosqlClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
NosqlClientand 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 NosqlClientCompositeOperations object
Calls
change_table_compartment()and waits for theWorkRequestto enter the given state(s).create_index_and_wait_for_state(...[, ...])Calls
create_index()and waits for theWorkRequestto enter the given state(s).create_replica_and_wait_for_state(...[, ...])Calls
create_replica()and waits for theWorkRequestto enter the given state(s).create_table_and_wait_for_state(...[, ...])Calls
create_table()and waits for theWorkRequestto enter the given state(s).delete_index_and_wait_for_state(...[, ...])Calls
delete_index()and waits for theWorkRequestto enter the given state(s).delete_replica_and_wait_for_state(...[, ...])Calls
delete_replica()and waits for theWorkRequestto enter the given state(s).delete_table_and_wait_for_state(table_name_or_id)Calls
delete_table()and waits for theWorkRequestto enter the given state(s).Calls
delete_work_request()and waits for theWorkRequestto enter the given state(s).unassign_kms_key_and_wait_for_state(...[, ...])Calls
unassign_kms_key()and waits for theWorkRequestto enter the given state(s).Calls
update_configuration()and waits for theWorkRequestto enter the given state(s).update_table_and_wait_for_state(...[, ...])Calls
update_table()and waits for theWorkRequestto enter the given state(s).- __init__(client, **kwargs)¶
Creates a new NosqlClientCompositeOperations object
- Parameters
client (NosqlClient) – The service client which will be wrapped by this object
- change_table_compartment_and_wait_for_state(table_name_or_id, change_table_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
change_table_compartment()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
change_table_compartment_details (oci.nosql.models.ChangeTableCompartmentDetails) – (required) Specifications of the source and target compartments.
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_table_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
- create_index_and_wait_for_state(table_name_or_id, create_index_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_index()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
create_index_details (oci.nosql.models.CreateIndexDetails) – (required) Specifications for the new index.
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_index()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_replica_and_wait_for_state(table_name_or_id, create_replica_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_replica()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
create_replica_details (oci.nosql.models.CreateReplicaDetails) – (required) Specifications for the new replica
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_replica()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_table_and_wait_for_state(create_table_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_table()and waits for theWorkRequestto enter the given state(s).- Parameters
create_table_details (oci.nosql.models.CreateTableDetails) – (required) Specifications for the new table.
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_table()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_index_and_wait_for_state(table_name_or_id, index_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_index()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
index_name (str) – (required) The name of a table’s index.
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_index()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_replica_and_wait_for_state(table_name_or_id, region, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_replica()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
region (str) – (required) A customer-facing region 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_replica()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_table_and_wait_for_state(table_name_or_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_table()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
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_table()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_work_request_and_wait_for_state(work_request_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_work_request()and waits for theWorkRequestto enter the given state(s).- Parameters
work_request_id (str) – (required) The ID of the asynchronous request.
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_work_request()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
- unassign_kms_key_and_wait_for_state(compartment_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
unassign_kms_key()and waits for theWorkRequestto enter the given state(s).- Parameters
compartment_id (str) – (required) The ID of a table’s compartment.
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
unassign_kms_key()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_configuration_and_wait_for_state(compartment_id, update_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_configuration()and waits for theWorkRequestto enter the given state(s).- Parameters
compartment_id (str) – (required) The ID of a table’s compartment.
update_configuration_details (oci.nosql.models.UpdateConfigurationDetails) – (required) The configuration details.
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
update_configuration()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_table_and_wait_for_state(table_name_or_id, update_table_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_table()and waits for theWorkRequestto enter the given state(s).- Parameters
table_name_or_id (str) – (required) A table name within the compartment, or a table OCID.
update_table_details (oci.nosql.models.UpdateTableDetails) – (required) Specifications for the alteration.
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
update_table()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