BdsClientCompositeOperations¶

class oci.bds.BdsClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around BdsClient 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 BdsClientCompositeOperations object
`activate_bds_metastore_configuration_and_wait_for_state`(…)	Calls `activate_bds_metastore_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`add_auto_scaling_configuration_and_wait_for_state`(…)	Calls `add_auto_scaling_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`add_block_storage_and_wait_for_state`(…[, …])	Calls `add_block_storage()` and waits for the `WorkRequest` to enter the given state(s).
`add_cloud_sql_and_wait_for_state`(…[, …])	Calls `add_cloud_sql()` and waits for the `WorkRequest` to enter the given state(s).
`add_worker_nodes_and_wait_for_state`(…[, …])	Calls `add_worker_nodes()` and waits for the `WorkRequest` to enter the given state(s).
`change_bds_instance_compartment_and_wait_for_state`(…)	Calls `change_bds_instance_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`change_shape_and_wait_for_state`(…[, …])	Calls `change_shape()` and waits for the `WorkRequest` to enter the given state(s).
`create_bds_api_key_and_wait_for_state`(…[, …])	Calls `create_bds_api_key()` and waits for the `WorkRequest` to enter the given state(s).
`create_bds_instance_and_wait_for_state`(…)	Calls `create_bds_instance()` and waits for the `WorkRequest` to enter the given state(s).
`create_bds_metastore_configuration_and_wait_for_state`(…)	Calls `create_bds_metastore_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`delete_bds_api_key_and_wait_for_state`(…[, …])	Calls `delete_bds_api_key()` and waits for the `WorkRequest` to enter the given state(s).
`delete_bds_instance_and_wait_for_state`(…)	Calls `delete_bds_instance()` and waits for the `WorkRequest` to enter the given state(s).
`delete_bds_metastore_configuration_and_wait_for_state`(…)	Calls `delete_bds_metastore_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`install_patch_and_wait_for_state`(…[, …])	Calls `install_patch()` and waits for the `WorkRequest` to enter the given state(s).
`remove_auto_scaling_configuration_and_wait_for_state`(…)	Calls `remove_auto_scaling_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`remove_cloud_sql_and_wait_for_state`(…[, …])	Calls `remove_cloud_sql()` and waits for the `WorkRequest` to enter the given state(s).
`remove_node_and_wait_for_state`(…[, …])	Calls `remove_node()` and waits for the `WorkRequest` to enter the given state(s).
`restart_node_and_wait_for_state`(…[, …])	Calls `restart_node()` and waits for the `WorkRequest` to enter the given state(s).
`test_bds_metastore_configuration_and_wait_for_state`(…)	Calls `test_bds_metastore_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`test_bds_object_storage_connection_and_wait_for_state`(…)	Calls `test_bds_object_storage_connection()` and waits for the `WorkRequest` to enter the given state(s).
`update_auto_scaling_configuration_and_wait_for_state`(…)	Calls `update_auto_scaling_configuration()` and waits for the `WorkRequest` to enter the given state(s).
`update_bds_instance_and_wait_for_state`(…)	Calls `update_bds_instance()` and waits for the `WorkRequest` to enter the given state(s).
`update_bds_metastore_configuration_and_wait_for_state`(…)	Calls `update_bds_metastore_configuration()` and waits for the `WorkRequest` to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new BdsClientCompositeOperations object

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

activate_bds_metastore_configuration_and_wait_for_state(bds_instance_id, metastore_config_id, activate_bds_metastore_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
metastore_config_id (str) – (required) The metastore configuration ID
activate_bds_metastore_configuration_details (oci.bds.models.ActivateBdsMetastoreConfigurationDetails) – (required) The request body when activating specified metastore configuration.
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 activate_bds_metastore_configuration()
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

add_auto_scaling_configuration_and_wait_for_state(bds_instance_id, add_auto_scaling_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
add_auto_scaling_configuration_details (oci.bds.models.AddAutoScalingConfigurationDetails) – (required) Details for creating an autoscale configuration.
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_auto_scaling_configuration()
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

add_block_storage_and_wait_for_state(bds_instance_id, add_block_storage_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
add_block_storage_details (oci.bds.models.AddBlockStorageDetails) – (required) Details for the added block storage.
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_block_storage()
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

add_cloud_sql_and_wait_for_state(bds_instance_id, add_cloud_sql_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
add_cloud_sql_details (oci.bds.models.AddCloudSqlDetails) – (required) Details for the Cloud SQL capability
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_cloud_sql()
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

add_worker_nodes_and_wait_for_state(bds_instance_id, add_worker_nodes_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
add_worker_nodes_details (oci.bds.models.AddWorkerNodesDetails) – (required) Details for the newly added nodes.
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_worker_nodes()
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_bds_instance_compartment_and_wait_for_state(bds_instance_id, change_bds_instance_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
change_bds_instance_compartment_details (oci.bds.models.ChangeBdsInstanceCompartmentDetails) – (required) Details for the comparment change.
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_bds_instance_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_shape_and_wait_for_state(bds_instance_id, change_shape_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
change_shape_details (oci.bds.models.ChangeShapeDetails) – (required) Individual change shape settings per node type. You can change the shape of master, worker, utility and Cloud SQL nodes.
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_shape()
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_bds_api_key_and_wait_for_state(bds_instance_id, create_bds_api_key_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
create_bds_api_key_details (oci.bds.models.CreateBdsApiKeyDetails) – (required) Create a new user’s API key.
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_bds_api_key()
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_bds_instance_and_wait_for_state(create_bds_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

create_bds_instance_details (oci.bds.models.CreateBdsInstanceDetails) – (required) Details for the new cluster.
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_bds_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

create_bds_metastore_configuration_and_wait_for_state(bds_instance_id, create_bds_metastore_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
create_bds_metastore_configuration_details (oci.bds.models.CreateBdsMetastoreConfigurationDetails) – (required) The request body when creating and activating external metastore configuration.
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_bds_metastore_configuration()
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_bds_api_key_and_wait_for_state(bds_instance_id, api_key_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
api_key_id (str) – (required) The API key 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_bds_api_key()
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_bds_instance_and_wait_for_state(bds_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
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_bds_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

delete_bds_metastore_configuration_and_wait_for_state(bds_instance_id, metastore_config_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
metastore_config_id (str) – (required) The metastore configuration ID
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_bds_metastore_configuration()
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

install_patch_and_wait_for_state(bds_instance_id, install_patch_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
install_patch_details (oci.bds.models.InstallPatchDetails) – (required) Details of the patch to be installed.
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 install_patch()
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

remove_auto_scaling_configuration_and_wait_for_state(bds_instance_id, auto_scaling_configuration_id, remove_auto_scaling_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
auto_scaling_configuration_id (str) – (required) Unique Oracle-assigned identifier of the autoscale configuration.
remove_auto_scaling_configuration_details (oci.bds.models.RemoveAutoScalingConfigurationDetails) – (required) Details for the autoscale configuration
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 remove_auto_scaling_configuration()
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

remove_cloud_sql_and_wait_for_state(bds_instance_id, remove_cloud_sql_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
remove_cloud_sql_details (oci.bds.models.RemoveCloudSqlDetails) – (required) Details for the Cloud SQL capability
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 remove_cloud_sql()
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

remove_node_and_wait_for_state(bds_instance_id, remove_node_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
remove_node_details (oci.bds.models.RemoveNodeDetails) – (required) Details for the node to be removed.
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 remove_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

restart_node_and_wait_for_state(bds_instance_id, restart_node_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
restart_node_details (oci.bds.models.RestartNodeDetails) – (required) Details for restarting the node.
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 restart_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

test_bds_metastore_configuration_and_wait_for_state(bds_instance_id, metastore_config_id, test_bds_metastore_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
metastore_config_id (str) – (required) The metastore configuration ID
test_bds_metastore_configuration_details (oci.bds.models.TestBdsMetastoreConfigurationDetails) – (required) Request body for testing BDS metastore configuration.
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 test_bds_metastore_configuration()
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

test_bds_object_storage_connection_and_wait_for_state(bds_instance_id, api_key_id, test_bds_object_storage_connection_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
api_key_id (str) – (required) The API key identifier.
test_bds_object_storage_connection_details (oci.bds.models.TestBdsObjectStorageConnectionDetails) – (required) Parameters required to validate access to the specified Object Storage bucket using the API key.
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 test_bds_object_storage_connection()
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_auto_scaling_configuration_and_wait_for_state(bds_instance_id, auto_scaling_configuration_id, update_auto_scaling_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
auto_scaling_configuration_id (str) – (required) Unique Oracle-assigned identifier of the autoscale configuration.
update_auto_scaling_configuration_details (oci.bds.models.UpdateAutoScalingConfigurationDetails) – (required) Details for update an autoscaling configuration.
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_auto_scaling_configuration()
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_bds_instance_and_wait_for_state(bds_instance_id, update_bds_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
update_bds_instance_details (oci.bds.models.UpdateBdsInstanceDetails) – (required) Details for the cluster 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_bds_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

update_bds_metastore_configuration_and_wait_for_state(bds_instance_id, metastore_config_id, update_bds_metastore_configuration_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters:

bds_instance_id (str) – (required) The OCID of the cluster.
metastore_config_id (str) – (required) The metastore configuration ID
update_bds_metastore_configuration_details (oci.bds.models.UpdateBdsMetastoreConfigurationDetails) – (required) Request body for updating BDS metastore configuration.
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_bds_metastore_configuration()
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