OciCacheUserClientCompositeOperations

class oci.redis.OciCacheUserClientCompositeOperations(client, work_request_clients=None, **kwargs)

This class provides a wrapper around OciCacheUserClient 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 OciCacheUserClientCompositeOperations object
change_oci_cache_user_compartment_and_wait_for_state(…) Calls change_oci_cache_user_compartment() and waits for the WorkRequest to enter the given state(s).
create_oci_cache_user_and_wait_for_state(…) Calls create_oci_cache_user() and waits for the WorkRequest to enter the given state(s).
delete_oci_cache_user_and_wait_for_state(…) Calls delete_oci_cache_user() and waits for the WorkRequest to enter the given state(s).
update_oci_cache_user_and_wait_for_state(…) Calls update_oci_cache_user() and waits for the WorkRequest to enter the given state(s).
__init__(client, work_request_clients=None, **kwargs)

Creates a new OciCacheUserClientCompositeOperations object

Parameters:
  • client (OciCacheUserClient) – 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.

change_oci_cache_user_compartment_and_wait_for_state(oci_cache_user_id, change_oci_cache_user_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oci_cache_user_id (str) – (required) A filter to return only resources, that match with the given OCI cache user ID (OCID).
  • change_oci_cache_user_compartment_details (oci.redis.models.ChangeOciCacheUserCompartmentDetails) – (required) The configuration details to move compartment operation for an OCI cache user.
  • 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_oci_cache_user_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
create_oci_cache_user_and_wait_for_state(create_oci_cache_user_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • create_oci_cache_user_details (oci.redis.models.CreateOciCacheUserDetails) – (required) Details required to create a new OCI cache user.
  • 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_oci_cache_user()
  • 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_oci_cache_user_and_wait_for_state(oci_cache_user_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oci_cache_user_id (str) – (required) A filter to return only resources, that match with the given OCI cache user ID (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_oci_cache_user()
  • 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_oci_cache_user_and_wait_for_state(oci_cache_user_id, update_oci_cache_user_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

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

Parameters:
  • oci_cache_user_id (str) – (required) A filter to return only resources, that match with the given OCI cache user ID (OCID).
  • update_oci_cache_user_details (oci.redis.models.UpdateOciCacheUserDetails) – (required) The information to be updated for an existing OCI Cache User.
  • 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_oci_cache_user()
  • 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