Package com.oracle.bmc.redis

Interface OciCacheUserAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OciCacheUserAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public interface OciCacheUserAsync
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.

    • 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 serice.

      • 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

      • createOciCacheUser

        Future<CreateOciCacheUserResponse> createOciCacheUser​(CreateOciCacheUserRequest request,
                                                      AsyncHandler<CreateOciCacheUserRequest,​CreateOciCacheUserResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteOciCacheUser

        Future<DeleteOciCacheUserResponse> deleteOciCacheUser​(DeleteOciCacheUserRequest request,
                                                      AsyncHandler<DeleteOciCacheUserRequest,​DeleteOciCacheUserResponse> handler)
        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
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getOciCacheUser

        Future<GetOciCacheUserResponse> getOciCacheUser​(GetOciCacheUserRequest request,
                                                AsyncHandler<GetOciCacheUserRequest,​GetOciCacheUserResponse> handler)
        Get an existing OCI Cache users based on the ID (OCID).
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listOciCacheUsers

        Future<ListOciCacheUsersResponse> listOciCacheUsers​(ListOciCacheUsersRequest request,
                                                    AsyncHandler<ListOciCacheUsersRequest,​ListOciCacheUsersResponse> handler)
        Lists the OCI Cache users based on the supplied parameters.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateOciCacheUser

        Future<UpdateOciCacheUserResponse> updateOciCacheUser​(UpdateOciCacheUserRequest request,
                                                      AsyncHandler<UpdateOciCacheUserRequest,​UpdateOciCacheUserResponse> handler)
        Update an existing OCI Cache User with new details.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.