DbSystemClientCompositeOperations

class oci.mysql.DbSystemClientCompositeOperations(client, **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, **kwargs) Creates a new DbSystemClientCompositeOperations object
add_analytics_cluster_and_wait_for_state(…) Calls add_analytics_cluster() 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_analytics_cluster_and_wait_for_state(…) Calls delete_analytics_cluster() 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).
generate_analytics_cluster_memory_estimate_and_wait_for_state(…) Calls generate_analytics_cluster_memory_estimate() and waits for the WorkRequest to enter the given state(s).
restart_analytics_cluster_and_wait_for_state(…) Calls restart_analytics_cluster() 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).
start_analytics_cluster_and_wait_for_state(…) Calls start_analytics_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).
stop_analytics_cluster_and_wait_for_state(…) Calls stop_analytics_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).
update_analytics_cluster_and_wait_for_state(…) Calls update_analytics_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).
__init__(client, **kwargs)

Creates a new DbSystemClientCompositeOperations object

Parameters:client (DbSystemClient) – The service client which will be wrapped by this object
add_analytics_cluster_and_wait_for_state(db_system_id, add_analytics_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • db_system_id (str) –

    (required) The DB System OCID.

  • add_analytics_cluster_details (oci.mysql.models.AddAnalyticsClusterDetails) – (required) Request to add an Analytics 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_analytics_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
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_analytics_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_analytics_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_analytics_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
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
generate_analytics_cluster_memory_estimate_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls generate_analytics_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_analytics_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_analytics_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls restart_analytics_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_analytics_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
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
start_analytics_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls start_analytics_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_analytics_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
stop_analytics_cluster_and_wait_for_state(db_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls stop_analytics_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_analytics_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
update_analytics_cluster_and_wait_for_state(db_system_id, update_analytics_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • db_system_id (str) –

    (required) The DB System OCID.

  • update_analytics_cluster_details (oci.mysql.models.UpdateAnalyticsClusterDetails) – (required) Request to update an Analytics 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_analytics_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