Package com.oracle.bmc.redis

Interface OciCacheUser

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OciCacheUserClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public interface OciCacheUser
extends AutoCloseable
    Use the OCI Cache API to create and manage clusters.

    A cluster is a memory-based storage solution. For more information, see OCI Cache. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeOciCacheUserCompartment

        ChangeOciCacheUserCompartmentResponse changeOciCacheUserCompartment​(ChangeOciCacheUserCompartmentRequest request)
        Moves an OCI Cache User from one compartment to another within the same tenancy.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/ChangeOciCacheUserCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOciCacheUserCompartment API.

      • createOciCacheUser

        CreateOciCacheUserResponse createOciCacheUser​(CreateOciCacheUserRequest request)
        Creates a new OCI Cache user.

        OCI Cache user is required to authenticate to OCI Cache cluster.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/CreateOciCacheUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOciCacheUser API.

      • deleteOciCacheUser

        DeleteOciCacheUserResponse deleteOciCacheUser​(DeleteOciCacheUserRequest request)
        Deletes an existing OCI Cache User based on the OCI cache user unique ID (OCID).
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/DeleteOciCacheUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOciCacheUser API.

      • getOciCacheUser

        GetOciCacheUserResponse getOciCacheUser​(GetOciCacheUserRequest request)
        Get an existing OCI Cache users based on the ID (OCID).
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/GetOciCacheUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOciCacheUser API.

      • listAttachedRedisClusters

        ListAttachedRedisClustersResponse listAttachedRedisClusters​(ListAttachedRedisClustersRequest request)
        Gets a list of associated redis cluster for an OCI cache user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/ListAttachedRedisClustersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAttachedRedisClusters API.

      • listOciCacheUsers

        ListOciCacheUsersResponse listOciCacheUsers​(ListOciCacheUsersRequest request)
        Lists the OCI Cache users based on the supplied parameters.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/ListOciCacheUsersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOciCacheUsers API.

      • updateOciCacheUser

        UpdateOciCacheUserResponse updateOciCacheUser​(UpdateOciCacheUserRequest request)
        Update an existing OCI Cache User with new details.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.67.2/redis/UpdateOciCacheUserExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOciCacheUser API.

      • getWaiters

        OciCacheUserWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        OciCacheUserPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.