Share via


DatabaseInner Class

public final class DatabaseInner
extends ProxyResource

Describes a database on the Redis Enterprise cluster.

Constructor Summary

Constructor Description
DatabaseInner()

Creates an instance of DatabaseInner class.

Method Summary

Modifier and Type Method and Description
AccessKeysAuthentication accessKeysAuthentication()

Get the accessKeysAuthentication property: This property can be Enabled/Disabled to allow or deny access with the current access keys.

Protocol clientProtocol()

Get the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols.

ClusteringPolicy clusteringPolicy()

Get the clusteringPolicy property: Clustering policy - default is OSSCluster.

DeferUpgradeSetting deferUpgrade()

Get the deferUpgrade property: Option to defer upgrade when newest version is released - default is NotDeferred.

EvictionPolicy evictionPolicy()

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

static DatabaseInner fromJson(JsonReader jsonReader)

Reads an instance of DatabaseInner from the JsonReader.

DatabasePropertiesGeoReplication geoReplication()

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

String id()

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

List<Module> modules()

Get the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time.

String name()

Get the name property: The name of the resource.

Persistence persistence()

Get the persistence property: Persistence settings.

Integer port()

Get the port property: TCP port of the database endpoint.

ProvisioningState provisioningState()

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

String redisVersion()

Get the redisVersion property: Version of Redis the database is running on, e.g.

ResourceState resourceState()

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

SystemData systemData()

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

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

DatabaseInner withAccessKeysAuthentication(AccessKeysAuthentication accessKeysAuthentication)

Set the accessKeysAuthentication property: This property can be Enabled/Disabled to allow or deny access with the current access keys.

DatabaseInner withClientProtocol(Protocol clientProtocol)

Set the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols.

DatabaseInner withClusteringPolicy(ClusteringPolicy clusteringPolicy)

Set the clusteringPolicy property: Clustering policy - default is OSSCluster.

DatabaseInner withDeferUpgrade(DeferUpgradeSetting deferUpgrade)

Set the deferUpgrade property: Option to defer upgrade when newest version is released - default is NotDeferred.

DatabaseInner withEvictionPolicy(EvictionPolicy evictionPolicy)

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

DatabaseInner withGeoReplication(DatabasePropertiesGeoReplication geoReplication)

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

DatabaseInner withModules(List<Module> modules)

Set the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time.

DatabaseInner withPersistence(Persistence persistence)

Set the persistence property: Persistence settings.

DatabaseInner withPort(Integer port)

Set the port property: TCP port of the database endpoint.

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Constructor Details

DatabaseInner

public DatabaseInner()

Creates an instance of DatabaseInner class.

Method Details

accessKeysAuthentication

public AccessKeysAuthentication accessKeysAuthentication()

Get 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 Protocol clientProtocol()

Get 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 ClusteringPolicy clusteringPolicy()

Get 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 DeferUpgradeSetting deferUpgrade()

Get 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 EvictionPolicy evictionPolicy()

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

Returns:

the evictionPolicy value.

fromJson

public static DatabaseInner fromJson(JsonReader jsonReader)

Reads an instance of DatabaseInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DatabaseInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

geoReplication

public DatabasePropertiesGeoReplication geoReplication()

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

Returns:

the geoReplication value.

id

public String id()

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

Overrides:

DatabaseInner.id()

Returns:

the id value.

modules

public List<Module> modules()

Get 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 String name()

Get the name property: The name of the resource.

Overrides:

DatabaseInner.name()

Returns:

the name value.

persistence

public Persistence persistence()

Get the persistence property: Persistence settings.

Returns:

the persistence value.

port

public Integer port()

Get the port property: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

Returns:

the port value.

provisioningState

public ProvisioningState provisioningState()

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

Returns:

the provisioningState value.

redisVersion

public String redisVersion()

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

Returns:

the redisVersion value.

resourceState

public ResourceState resourceState()

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

Returns:

the resourceState value.

systemData

public SystemData systemData()

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

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DatabaseInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

DatabaseInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAccessKeysAuthentication

public DatabaseInner withAccessKeysAuthentication(AccessKeysAuthentication accessKeysAuthentication)

Set 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.

Parameters:

accessKeysAuthentication - the accessKeysAuthentication value to set.

Returns:

the DatabaseInner object itself.

withClientProtocol

public DatabaseInner withClientProtocol(Protocol clientProtocol)

Set the clientProtocol property: Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

Parameters:

clientProtocol - the clientProtocol value to set.

Returns:

the DatabaseInner object itself.

withClusteringPolicy

public DatabaseInner withClusteringPolicy(ClusteringPolicy clusteringPolicy)

Set 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.

Parameters:

clusteringPolicy - the clusteringPolicy value to set.

Returns:

the DatabaseInner object itself.

withDeferUpgrade

public DatabaseInner withDeferUpgrade(DeferUpgradeSetting deferUpgrade)

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

Parameters:

deferUpgrade - the deferUpgrade value to set.

Returns:

the DatabaseInner object itself.

withEvictionPolicy

public DatabaseInner withEvictionPolicy(EvictionPolicy evictionPolicy)

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

Parameters:

evictionPolicy - the evictionPolicy value to set.

Returns:

the DatabaseInner object itself.

withGeoReplication

public DatabaseInner withGeoReplication(DatabasePropertiesGeoReplication geoReplication)

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

Parameters:

geoReplication - the geoReplication value to set.

Returns:

the DatabaseInner object itself.

withModules

public DatabaseInner withModules(List<Module> modules)

Set the modules property: Optional set of redis modules to enable in this database - modules can only be added at creation time.

Parameters:

modules - the modules value to set.

Returns:

the DatabaseInner object itself.

withPersistence

public DatabaseInner withPersistence(Persistence persistence)

Set the persistence property: Persistence settings.

Parameters:

persistence - the persistence value to set.

Returns:

the DatabaseInner object itself.

withPort

public DatabaseInner withPort(Integer port)

Set the port property: TCP port of the database endpoint. Specified at create time. Defaults to an available port.

Parameters:

port - the port value to set.

Returns:

the DatabaseInner object itself.

Applies to