ReplicasClientCompositeOperations

class oci.mysql.ReplicasClientCompositeOperations(client, **kwargs)

This class provides a wrapper around ReplicasClient 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 ReplicasClientCompositeOperations object
create_replica_and_wait_for_state(…[, …]) Calls create_replica() and waits for the WorkRequest to enter the given state(s).
delete_replica_and_wait_for_state(replica_id) Calls delete_replica() and waits for the WorkRequest to enter the given state(s).
update_replica_and_wait_for_state(…[, …]) Calls update_replica() and waits for the WorkRequest to enter the given state(s).
__init__(client, **kwargs)

Creates a new ReplicasClientCompositeOperations object

Parameters:client (ReplicasClient) – The service client which will be wrapped by this object
create_replica_and_wait_for_state(create_replica_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_replica_details (oci.mysql.models.CreateReplicaDetails) – (required) The parameters of the request to create the read replica.
  • 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_replica()
  • 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_replica_and_wait_for_state(replica_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • replica_id (str) –

    (required) The Replica 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_replica()
  • 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_replica_and_wait_for_state(replica_id, update_replica_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • replica_id (str) –

    (required) The Replica OCID.

  • update_replica_details (oci.mysql.models.UpdateReplicaDetails) – (required) The parameters of the request to update the read replica.
  • 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_replica()
  • 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