Package com.azure.resourcemanager.redisenterprise.models

Interface Database

  • public interface Database
    An immutable client-side representation of Database.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • clientProtocol

        Protocol clientProtocol()
        Gets the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
        Returns:
        the clientProtocol value.

      • port

        Integer port()
        Gets the port property: TCP port of the database endpoint. Specified at create time. Defaults to an available port.
        Returns:
        the port value.

      • provisioningState

        ProvisioningState provisioningState()
        Gets the provisioningState property: Current provisioning status of the database.
        Returns:
        the provisioningState value.

      • resourceState

        ResourceState resourceState()
        Gets the resourceState property: Current resource status of the database.
        Returns:
        the resourceState value.

      • clusteringPolicy

        ClusteringPolicy clusteringPolicy()
        Gets the clusteringPolicy property: Clustering policy - default is OSSCluster. Specified at create time.
        Returns:
        the clusteringPolicy value.

      • evictionPolicy

        EvictionPolicy evictionPolicy()
        Gets the evictionPolicy property: Redis eviction policy - default is VolatileLRU.
        Returns:
        the evictionPolicy value.

      • persistence

        Persistence persistence()
        Gets the persistence property: Persistence settings.
        Returns:
        the persistence value.

      • modules

        List<Module> modules()
        Gets the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time.
        Returns:
        the modules value.

      • geoReplication

        DatabasePropertiesGeoReplication geoReplication()
        Gets the geoReplication property: Optional set of properties to configure geo replication for this database.
        Returns:
        the geoReplication value.

      • innerModel

        DatabaseInner innerModel()
        Gets the inner com.azure.resourcemanager.redisenterprise.fluent.models.DatabaseInner object.
        Returns:
        the inner object.

      • update

        Database.Update update()
        Begins update for the Database resource.
        Returns:
        the stage of resource update.

      • refresh

        Database refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        Database refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • listKeys

        AccessKeys listKeys()
        Retrieves the access keys for the RedisEnterprise database.
        Returns:
        access keys.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeysWithResponse

        com.azure.core.http.rest.Response<AccessKeys> listKeysWithResponse​(com.azure.core.util.Context context)
        Retrieves the access keys for the RedisEnterprise database.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        access keys along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • regenerateKey

        AccessKeys regenerateKey​(RegenerateKeyParameters parameters)
        Regenerates the RedisEnterprise database's access keys.
        Parameters:
        parameters - Specifies which key to regenerate.
        Returns:
        access keys.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • regenerateKey

        AccessKeys regenerateKey​(RegenerateKeyParameters parameters,
                         com.azure.core.util.Context context)
        Regenerates the RedisEnterprise database's access keys.
        Parameters:
        parameters - Specifies which key to regenerate.
        context - The context to associate with this operation.
        Returns:
        access keys.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • importMethod

        void importMethod​(ImportClusterParameters parameters)
        Imports database files to target database.
        Parameters:
        parameters - Storage information for importing into the cluster.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • importMethod

        void importMethod​(ImportClusterParameters parameters,
                  com.azure.core.util.Context context)
        Imports database files to target database.
        Parameters:
        parameters - Storage information for importing into the cluster.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • export

        void export​(ExportClusterParameters parameters)
        Exports a database file from target database.
        Parameters:
        parameters - Storage information for exporting into the cluster.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • export

        void export​(ExportClusterParameters parameters,
            com.azure.core.util.Context context)
        Exports a database file from target database.
        Parameters:
        parameters - Storage information for exporting into the cluster.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • forceUnlink

        void forceUnlink​(ForceUnlinkParameters parameters)
        Forcibly removes the link to the specified database resource.
        Parameters:
        parameters - Information identifying the database to be unlinked.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • forceUnlink

        void forceUnlink​(ForceUnlinkParameters parameters,
                 com.azure.core.util.Context context)
        Forcibly removes the link to the specified database resource.
        Parameters:
        parameters - Information identifying the database to be unlinked.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.