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 functionality

Methods:

`__init__`(client, **kwargs)	Creates a new RedisClusterClientCompositeOperations object
`attach_oci_cache_users_and_wait_for_state`(...)	Calls `attach_oci_cache_users()` and waits for the `WorkRequest` to enter the given state(s).
`change_redis_cluster_compartment_and_wait_for_state`(...)	Calls `change_redis_cluster_compartment()` and waits for the `WorkRequest` to enter the given state(s).
`convert_to_secondary_cluster_and_wait_for_state`(...)	Calls `convert_to_secondary_cluster()` and waits for the `WorkRequest` to enter the given state(s).
`convert_to_standalone_cluster_and_wait_for_state`(...)	Calls `convert_to_standalone_cluster()` and waits for the `WorkRequest` to enter the given state(s).
`create_redis_cluster_and_wait_for_state`(...)	Calls `create_redis_cluster()` and waits for the `WorkRequest` to enter the given state(s).
`delete_redis_cluster_and_wait_for_state`(...)	Calls `delete_redis_cluster()` and waits for the `WorkRequest` to enter the given state(s).
`detach_oci_cache_users_and_wait_for_state`(...)	Calls `detach_oci_cache_users()` and waits for the `WorkRequest` to enter the given state(s).
`switchover_and_wait_for_state`(redis_cluster_id)	Calls `switchover()` and waits for the `WorkRequest` to enter the given state(s).
`update_redis_cluster_and_wait_for_state`(...)	Calls `update_redis_cluster()` and waits for the `WorkRequest` 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

attach_oci_cache_users_and_wait_for_state(redis_cluster_id, attach_oci_cache_users_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

redis_cluster_id (str) –
(required) The OCID of the cluster.
attach_oci_cache_users_details (oci.redis.models.AttachOciCacheUsersDetails) – (required) The parameter details to attach the OCI cache users to the redis 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 attach_oci_cache_users()
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_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 the WorkRequest 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 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

convert_to_secondary_cluster_and_wait_for_state(convert_to_secondary_cluster_details, redis_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

convert_to_secondary_cluster_details (oci.redis.models.ConvertToSecondaryClusterDetails) – (required) The parameter details required to convert an existing cluster into a secondary cluster.
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 convert_to_secondary_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

convert_to_standalone_cluster_and_wait_for_state(redis_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls convert_to_standalone_cluster() and waits for the WorkRequest 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 convert_to_standalone_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_redis_cluster_and_wait_for_state(create_redis_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_redis_cluster() and waits for the WorkRequest 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 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_redis_cluster_and_wait_for_state(redis_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_redis_cluster() and waits for the WorkRequest 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 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

detach_oci_cache_users_and_wait_for_state(redis_cluster_id, detach_oci_cache_users_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

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

Parameters

redis_cluster_id (str) –
(required) The OCID of the cluster.
detach_oci_cache_users_details (oci.redis.models.DetachOciCacheUsersDetails) – (required) The parameter details to detach the OCI cache users to the redis 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 detach_oci_cache_users()
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

switchover_and_wait_for_state(redis_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls switchover() and waits for the WorkRequest 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 switchover()
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_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 the WorkRequest 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 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