RedisClusterClientCompositeOperations¶
-
class
oci.redis.
RedisClusterClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
RedisClusterClient
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 functionalityMethods
__init__
(client, **kwargs)Creates a new RedisClusterClientCompositeOperations object change_redis_cluster_compartment_and_wait_for_state
(…)Calls change_redis_cluster_compartment()
and waits for theWorkRequest
to enter the given state(s).create_redis_cluster_and_wait_for_state
(…)Calls create_redis_cluster()
and waits for theWorkRequest
to enter the given state(s).delete_redis_cluster_and_wait_for_state
(…)Calls delete_redis_cluster()
and waits for theWorkRequest
to enter the given state(s).update_redis_cluster_and_wait_for_state
(…)Calls update_redis_cluster()
and waits for theWorkRequest
to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new RedisClusterClientCompositeOperations object
Parameters: client (RedisClusterClient) – The service client which will be wrapped by this object
-
change_redis_cluster_compartment_and_wait_for_state
(redis_cluster_id, change_redis_cluster_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_redis_cluster_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - redis_cluster_id (str) –
(required) The OCID of the cluster.
- change_redis_cluster_compartment_details (oci.redis.models.ChangeRedisClusterCompartmentDetails) – (required) The information 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
change_redis_cluster_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- redis_cluster_id (str) –
-
create_redis_cluster_and_wait_for_state
(create_redis_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_redis_cluster()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_redis_cluster_details (oci.redis.models.CreateRedisClusterDetails) – (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_redis_cluster()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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_redis_cluster_and_wait_for_state
(redis_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_redis_cluster()
and waits for theWorkRequest
to enter the given state(s).Parameters: - redis_cluster_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_redis_cluster()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- redis_cluster_id (str) –
-
update_redis_cluster_and_wait_for_state
(redis_cluster_id, update_redis_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_redis_cluster()
and waits for theWorkRequest
to enter the given state(s).Parameters: - redis_cluster_id (str) –
(required) The OCID of the cluster.
- update_redis_cluster_details (oci.redis.models.UpdateRedisClusterDetails) – (required) The information 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_redis_cluster()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_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
- redis_cluster_id (str) –
-