Database Interface

Package:

com.azure.resourcemanager.redisenterprise.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-redisenterprise:2.1.0

public interface Database

An immutable client-side representation of Database.

Method Summary

Modifier and Type	Method and Description
abstract AccessKeysAuthentication	accessKeysAuthentication() Gets the accessKeysAuthentication property: This property can be Enabled/Disabled to allow or deny access with the current access keys.
abstract Protocol	clientProtocol() Gets the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols.
abstract ClusteringPolicy	clusteringPolicy() Gets the clusteringPolicy property: Clustering policy - default is OSSCluster.
abstract DeferUpgradeSetting	deferUpgrade() Gets the deferUpgrade property: Option to defer upgrade when newest version is released - default is NotDeferred.
abstract EvictionPolicy	evictionPolicy() Gets the evictionPolicy property: Redis eviction policy - default is VolatileLRU.
abstract void	export(ExportClusterParameters parameters) Exports a database file from target database.
abstract void	export(ExportClusterParameters parameters, Context context) Exports a database file from target database.
abstract void	flush() Flushes all the keys in this database and also from its linked databases.
abstract void	flush(FlushParameters parameters, Context context) Flushes all the keys in this database and also from its linked databases.
abstract void	forceLinkToReplicationGroup(ForceLinkParameters parameters) Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group.
abstract void	forceLinkToReplicationGroup(ForceLinkParameters parameters, Context context) Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group.
abstract void	forceUnlink(ForceUnlinkParameters parameters) Forcibly removes the link to the specified database resource.
abstract void	forceUnlink(ForceUnlinkParameters parameters, Context context) Forcibly removes the link to the specified database resource.
abstract DatabasePropertiesGeoReplication	geoReplication() Gets the geoReplication property: Optional set of properties to configure geo replication for this database.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract void	importMethod(ImportClusterParameters parameters) Imports database files to target database.
abstract void	importMethod(ImportClusterParameters parameters, Context context) Imports database files to target database.
abstract DatabaseInner	innerModel() Gets the inner com.azure.resourcemanager.redisenterprise.fluent.models.DatabaseInner object.
abstract AccessKeys	listKeys() Retrieves the access keys for the Redis Enterprise database.
abstract Response<AccessKeys>	listKeysWithResponse(Context context) Retrieves the access keys for the Redis Enterprise database.
abstract 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.
abstract String	name() Gets the name property: The name of the resource.
abstract Persistence	persistence() Gets the persistence property: Persistence settings.
abstract Integer	port() Gets the port property: TCP port of the database endpoint.
abstract ProvisioningState	provisioningState() Gets the provisioningState property: Current provisioning status of the database.
abstract String	redisVersion() Gets the redisVersion property: Version of Redis the database is running on, e.g.
abstract Database	refresh() Refreshes the resource to sync with Azure.
abstract Database	refresh(Context context) Refreshes the resource to sync with Azure.
abstract AccessKeys	regenerateKey(RegenerateKeyParameters parameters) Regenerates the Redis Enterprise database's access keys.
abstract AccessKeys	regenerateKey(RegenerateKeyParameters parameters, Context context) Regenerates the Redis Enterprise database's access keys.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract ResourceState	resourceState() Gets the resourceState property: Current resource status of the database.
abstract SystemData	systemData() Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the Database resource.
abstract void	upgradeDBRedisVersion() Upgrades the database Redis version to the latest available.
abstract void	upgradeDBRedisVersion(Context context) Upgrades the database Redis version to the latest available.

Method Details

accessKeysAuthentication

public abstract AccessKeysAuthentication accessKeysAuthentication()

Gets the accessKeysAuthentication property: This property can be Enabled/Disabled to allow or deny access with the current access keys. Can be updated even after database is created.

Returns:

the accessKeysAuthentication value.

clientProtocol

public abstract 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.

clusteringPolicy

public abstract ClusteringPolicy clusteringPolicy()

Gets the clusteringPolicy property: Clustering policy - default is OSSCluster. This property can be updated only if the current value is NoCluster. If the value is OSSCluster or EnterpriseCluster, it cannot be updated without deleting the database.

Returns:

the clusteringPolicy value.

deferUpgrade

public abstract DeferUpgradeSetting deferUpgrade()

Gets the deferUpgrade property: Option to defer upgrade when newest version is released - default is NotDeferred. Learn more: https://aka.ms/redisversionupgrade.

Returns:

the deferUpgrade value.

evictionPolicy

public abstract EvictionPolicy evictionPolicy()

Gets the evictionPolicy property: Redis eviction policy - default is VolatileLRU.

Returns:

the evictionPolicy value.

export

public abstract void export(ExportClusterParameters parameters)

Exports a database file from target database.

Parameters:

parameters - Storage information for exporting into the cluster.

export

public abstract void export(ExportClusterParameters parameters, 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.

flush

public abstract void flush()

Flushes all the keys in this database and also from its linked databases.

flush

public abstract void flush(FlushParameters parameters, Context context)

Flushes all the keys in this database and also from its linked databases.

Parameters:

parameters - Information identifying the databases to be flushed.

context - The context to associate with this operation.

forceLinkToReplicationGroup

public abstract void forceLinkToReplicationGroup(ForceLinkParameters parameters)

Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. **IMPORTANT NOTE:** All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.

Parameters:

parameters - Information identifying the database to be unlinked.

forceLinkToReplicationGroup

public abstract void forceLinkToReplicationGroup(ForceLinkParameters parameters, Context context)

Forcibly recreates an existing database on the specified cluster, and rejoins it to an existing replication group. **IMPORTANT NOTE:** All data in this database will be discarded, and the database will temporarily be unavailable while rejoining the replication group.

Parameters:

parameters - Information identifying the database to be unlinked.

context - The context to associate with this operation.

forceUnlink

public abstract void forceUnlink(ForceUnlinkParameters parameters)

Forcibly removes the link to the specified database resource.

Parameters:

parameters - Information identifying the database to be unlinked.

forceUnlink

public abstract void forceUnlink(ForceUnlinkParameters parameters, 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.

geoReplication

public abstract DatabasePropertiesGeoReplication geoReplication()

Gets the geoReplication property: Optional set of properties to configure geo replication for this database.

Returns:

the geoReplication value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

importMethod

public abstract void importMethod(ImportClusterParameters parameters)

Imports database files to target database.

Parameters:

parameters - Storage information for importing into the cluster.

importMethod

public abstract void importMethod(ImportClusterParameters parameters, 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.

innerModel

public abstract DatabaseInner innerModel()

Gets the inner com.azure.resourcemanager.redisenterprise.fluent.models.DatabaseInner object.

Returns:

the inner object.

listKeys

public abstract AccessKeys listKeys()

Retrieves the access keys for the Redis Enterprise database.

Returns:

access keys.

listKeysWithResponse

public abstract Response<AccessKeys> listKeysWithResponse(Context context)

Retrieves the access keys for the Redis Enterprise database.

Parameters:

context - The context to associate with this operation.

Returns:

access keys along with Response<T>.

modules

public abstract 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.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

persistence

public abstract Persistence persistence()

Gets the persistence property: Persistence settings.

Returns:

the persistence value.

port

public abstract 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

public abstract ProvisioningState provisioningState()

Gets the provisioningState property: Current provisioning status of the database.

Returns:

the provisioningState value.

redisVersion

public abstract String redisVersion()

Gets the redisVersion property: Version of Redis the database is running on, e.g. '6.0'.

Returns:

the redisVersion value.

refresh

public abstract Database refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Database refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regenerateKey

public abstract AccessKeys regenerateKey(RegenerateKeyParameters parameters)

Regenerates the Redis Enterprise database's access keys.

Parameters:

parameters - Specifies which key to regenerate.

Returns:

access keys.

regenerateKey

public abstract AccessKeys regenerateKey(RegenerateKeyParameters parameters, Context context)

Regenerates the Redis Enterprise database's access keys.

Parameters:

parameters - Specifies which key to regenerate.

context - The context to associate with this operation.

Returns:

access keys.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

resourceState

public abstract ResourceState resourceState()

Gets the resourceState property: Current resource status of the database.

Returns:

the resourceState value.

systemData

public abstract SystemData systemData()

Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Database.Update update()

Begins update for the Database resource.

Returns:

the stage of resource update.

upgradeDBRedisVersion

public abstract void upgradeDBRedisVersion()

Upgrades the database Redis version to the latest available.

upgradeDBRedisVersion

public abstract void upgradeDBRedisVersion(Context context)

Upgrades the database Redis version to the latest available.

Parameters:

context - The context to associate with this operation.