DbSystemClientCompositeOperations

class oci.mysql.DbSystemClientCompositeOperations(client, work_request_clients=None, **kwargs)

This class provides a wrapper around DbSystemClient 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[, work_request_clients])	Creates a new DbSystemClientCompositeOperations object
add_heat_wave_cluster_and_wait_for_state(...)	Calls add_heat_wave_cluster() and waits for the WorkRequest to enter the given state(s).
controlled_update_db_system_and_wait_for_state(...)	Calls controlled_update_db_system() and waits for the WorkRequest to enter the given state(s).
create_db_system_and_wait_for_state(...[, ...])	Calls create_db_system() and waits for the WorkRequest to enter the given state(s).
delete_db_system_and_wait_for_state(db_system_id)	Calls delete_db_system() and waits for the WorkRequest to enter the given state(s).
delete_heat_wave_cluster_and_wait_for_state(...)	Calls delete_heat_wave_cluster() and waits for the WorkRequest to enter the given state(s).
generate_db_system_status_and_wait_for_state(...)	Calls generate_db_system_status() and waits for the WorkRequest to enter the given state(s).
generate_heat_wave_cluster_memory_estimate_and_wait_for_state(...)	Calls generate_heat_wave_cluster_memory_estimate() and waits for the WorkRequest to enter the given state(s).
restart_db_system_and_wait_for_state(...[, ...])	Calls restart_db_system() and waits for the WorkRequest to enter the given state(s).
restart_heat_wave_cluster_and_wait_for_state(...)	Calls restart_heat_wave_cluster() and waits for the WorkRequest to enter the given state(s).
start_db_system_and_wait_for_state(db_system_id)	Calls start_db_system() and waits for the WorkRequest to enter the given state(s).
start_heat_wave_cluster_and_wait_for_state(...)	Calls start_heat_wave_cluster() and waits for the WorkRequest to enter the given state(s).
stop_db_system_and_wait_for_state(...[, ...])	Calls stop_db_system() and waits for the WorkRequest to enter the given state(s).
stop_heat_wave_cluster_and_wait_for_state(...)	Calls stop_heat_wave_cluster() and waits for the WorkRequest to enter the given state(s).
update_db_system_and_wait_for_state(...[, ...])	Calls update_db_system() and waits for the WorkRequest to enter the given state(s).
update_heat_wave_cluster_and_wait_for_state(...)	Calls update_heat_wave_cluster() and waits for the WorkRequest to enter the given state(s).

__init__(client, work_request_clients=None, **kwargs)

Creates a new DbSystemClientCompositeOperations object

Parameters

• client (DbSystemClient) – 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_heat_wave_cluster_and_wait_for_state(db_system_id, add_heat_wave_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• add_heat_wave_cluster_details (oci.mysql.models.AddHeatWaveClusterDetails) – (required) Request to add a HeatWave 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 add_heat_wave_cluster()

• 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

controlled_update_db_system_and_wait_for_state(db_system_id, controlled_update_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• controlled_update_db_system_details (oci.mysql.models.ControlledUpdateDbSystemDetails) – (required) Required parameters for the controlled update action.

• 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 controlled_update_db_system()

• 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_db_system_and_wait_for_state(create_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• create_db_system_details (oci.mysql.models.CreateDbSystemDetails) – (required) Request to create a DB System.

• 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_db_system()

• 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_db_system_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_db_system()

• 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_heat_wave_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_heat_wave_cluster()

• 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_db_system_status_and_wait_for_state(db_system_id, generate_db_system_status_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• generate_db_system_status_details (oci.mysql.models.GenerateDbSystemStatusDetails) – (required) The parameters for selecting the attributes to collect the status of.

• 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_db_system_status()

• 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_heat_wave_cluster_memory_estimate_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_heat_wave_cluster_memory_estimate()

• 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_db_system_and_wait_for_state(db_system_id, restart_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• restart_db_system_details (oci.mysql.models.RestartDbSystemDetails) – (required) Optional parameters for the stop portion of the restart action.

• 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_db_system()

• 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_heat_wave_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_heat_wave_cluster()

• 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_db_system_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_db_system()

• 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_heat_wave_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_heat_wave_cluster()

• 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_db_system_and_wait_for_state(db_system_id, stop_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• stop_db_system_details (oci.mysql.models.StopDbSystemDetails) – (required) Optional parameters for the stop action.

• 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_db_system()

• 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_heat_wave_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• 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_heat_wave_cluster()

• 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_db_system_and_wait_for_state(db_system_id, update_db_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• update_db_system_details (oci.mysql.models.UpdateDbSystemDetails) – (required) Request to update a DB System.

• 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_db_system()

• 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_heat_wave_cluster_and_wait_for_state(db_system_id, update_heat_wave_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters

• db_system_id (str) –

  (required) The DB System OCID.

• update_heat_wave_cluster_details (oci.mysql.models.UpdateHeatWaveClusterDetails) – (required) Request to update a HeatWave 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 update_heat_wave_cluster()

• 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