Share via

RedisConfiguration Class

  • Reference
Package:
com.azure.resourcemanager.redis.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-redis:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.redis.models.RedisConfiguration

Implements

JsonSerializable<RedisConfiguration>

public final class RedisConfiguration
implements JsonSerializable<RedisConfiguration>

All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.

Constructor Summary

Constructor Description
RedisConfiguration()

Creates an instance of RedisConfiguration class.

Method Summary

Modifier and Type Method and Description
String aadEnabled()

Get the aadEnabled property: Specifies whether AAD based authentication has been enabled or disabled for the cache.
Map<String,String> additionalProperties()

Get the additionalProperties property: All Redis Settings.
String aofBackupEnabled()

Get the aofBackupEnabled property: Specifies whether the aof backup is enabled.
String aofStorageConnectionString0()

Get the aofStorageConnectionString0 property: First storage account connection string.
String aofStorageConnectionString1()

Get the aofStorageConnectionString1 property: Second storage account connection string.
String authnotrequired()

Get the authnotrequired property: Specifies whether the authentication is disabled.
static RedisConfiguration fromJson(JsonReader jsonReader)

Reads an instance of RedisConfiguration from the JsonReader.
String maxclients()

Get the maxclients property: The max clients config.
String maxfragmentationmemoryReserved()

Get the maxfragmentationmemoryReserved property: Value in megabytes reserved for fragmentation per shard.
String maxmemoryDelta()

Get the maxmemoryDelta property: Value in megabytes reserved for non-cache usage per shard e.g.
String maxmemoryPolicy()

Get the maxmemoryPolicy property: The eviction strategy used when your data won't fit within its memory limit.
String maxmemoryReserved()

Get the maxmemoryReserved property: Value in megabytes reserved for non-cache usage per shard e.g.
String notifyKeyspaceEvents()

Get the notifyKeyspaceEvents property: The keyspace events which should be monitored.
String preferredDataArchiveAuthMethod()

Get the preferredDataArchiveAuthMethod property: Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS.
String preferredDataPersistenceAuthMethod()

Get the preferredDataPersistenceAuthMethod property: Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS.
String rdbBackupEnabled()

Get the rdbBackupEnabled property: Specifies whether the rdb backup is enabled.
String rdbBackupFrequency()

Get the rdbBackupFrequency property: Specifies the frequency for creating rdb backup in minutes.
String rdbBackupMaxSnapshotCount()

Get the rdbBackupMaxSnapshotCount property: Specifies the maximum number of snapshots for rdb backup.
String rdbStorageConnectionString()

Get the rdbStorageConnectionString property: The storage account connection string for storing rdb file.
String storageSubscriptionId()

Get the storageSubscriptionId property: SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
RedisConfiguration withAadEnabled(String aadEnabled)

Set the aadEnabled property: Specifies whether AAD based authentication has been enabled or disabled for the cache.
RedisConfiguration withAdditionalProperties(Map<String,String> additionalProperties)

Set the additionalProperties property: All Redis Settings.
RedisConfiguration withAofBackupEnabled(String aofBackupEnabled)

Set the aofBackupEnabled property: Specifies whether the aof backup is enabled.
RedisConfiguration withAofStorageConnectionString0(String aofStorageConnectionString0)

Set the aofStorageConnectionString0 property: First storage account connection string.
RedisConfiguration withAofStorageConnectionString1(String aofStorageConnectionString1)

Set the aofStorageConnectionString1 property: Second storage account connection string.
RedisConfiguration withAuthnotrequired(String authnotrequired)

Set the authnotrequired property: Specifies whether the authentication is disabled.
RedisConfiguration withMaxfragmentationmemoryReserved(String maxfragmentationmemoryReserved)

Set the maxfragmentationmemoryReserved property: Value in megabytes reserved for fragmentation per shard.
RedisConfiguration withMaxmemoryDelta(String maxmemoryDelta)

Set the maxmemoryDelta property: Value in megabytes reserved for non-cache usage per shard e.g.
RedisConfiguration withMaxmemoryPolicy(String maxmemoryPolicy)

Set the maxmemoryPolicy property: The eviction strategy used when your data won't fit within its memory limit.
RedisConfiguration withMaxmemoryReserved(String maxmemoryReserved)

Set the maxmemoryReserved property: Value in megabytes reserved for non-cache usage per shard e.g.
RedisConfiguration withNotifyKeyspaceEvents(String notifyKeyspaceEvents)

Set the notifyKeyspaceEvents property: The keyspace events which should be monitored.
RedisConfiguration withPreferredDataPersistenceAuthMethod(String preferredDataPersistenceAuthMethod)

Set the preferredDataPersistenceAuthMethod property: Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS.
RedisConfiguration withRdbBackupEnabled(String rdbBackupEnabled)

Set the rdbBackupEnabled property: Specifies whether the rdb backup is enabled.
RedisConfiguration withRdbBackupFrequency(String rdbBackupFrequency)

Set the rdbBackupFrequency property: Specifies the frequency for creating rdb backup in minutes.
RedisConfiguration withRdbBackupMaxSnapshotCount(String rdbBackupMaxSnapshotCount)

Set the rdbBackupMaxSnapshotCount property: Specifies the maximum number of snapshots for rdb backup.
RedisConfiguration withRdbStorageConnectionString(String rdbStorageConnectionString)

Set the rdbStorageConnectionString property: The storage account connection string for storing rdb file.
RedisConfiguration withStorageSubscriptionId(String storageSubscriptionId)

Set the storageSubscriptionId property: SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.
String zonalConfiguration()

Get the zonalConfiguration property: Zonal Configuration.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RedisConfiguration

public RedisConfiguration()

Creates an instance of RedisConfiguration class.

Method Details

aadEnabled

public String aadEnabled()

Get the aadEnabled property: Specifies whether AAD based authentication has been enabled or disabled for the cache.

Returns:

the aadEnabled value.

additionalProperties

public Map additionalProperties()

Get the additionalProperties property: All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.

Returns:

the additionalProperties value.

aofBackupEnabled

public String aofBackupEnabled()

Get the aofBackupEnabled property: Specifies whether the aof backup is enabled.

Returns:

the aofBackupEnabled value.

aofStorageConnectionString0

public String aofStorageConnectionString0()

Get the aofStorageConnectionString0 property: First storage account connection string.

Returns:

the aofStorageConnectionString0 value.

aofStorageConnectionString1

public String aofStorageConnectionString1()

Get the aofStorageConnectionString1 property: Second storage account connection string.

Returns:

the aofStorageConnectionString1 value.

authnotrequired

public String authnotrequired()

Get the authnotrequired property: Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.

Returns:

the authnotrequired value.

fromJson

public static RedisConfiguration fromJson(JsonReader jsonReader)

Reads an instance of RedisConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the RedisConfiguration.

maxclients

public String maxclients()

Get the maxclients property: The max clients config.

Returns:

the maxclients value.

maxfragmentationmemoryReserved

public String maxfragmentationmemoryReserved()

Get the maxfragmentationmemoryReserved property: Value in megabytes reserved for fragmentation per shard.

Returns:

the maxfragmentationmemoryReserved value.

maxmemoryDelta

public String maxmemoryDelta()

Get the maxmemoryDelta property: Value in megabytes reserved for non-cache usage per shard e.g. failover.

Returns:

the maxmemoryDelta value.

maxmemoryPolicy

public String maxmemoryPolicy()

Get the maxmemoryPolicy property: The eviction strategy used when your data won't fit within its memory limit.

Returns:

the maxmemoryPolicy value.

maxmemoryReserved

public String maxmemoryReserved()

Get the maxmemoryReserved property: Value in megabytes reserved for non-cache usage per shard e.g. failover.

Returns:

the maxmemoryReserved value.

notifyKeyspaceEvents

public String notifyKeyspaceEvents()

Get the notifyKeyspaceEvents property: The keyspace events which should be monitored.

Returns:

the notifyKeyspaceEvents value.

preferredDataArchiveAuthMethod

public String preferredDataArchiveAuthMethod()

Get the preferredDataArchiveAuthMethod property: Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS.

Returns:

the preferredDataArchiveAuthMethod value.

preferredDataPersistenceAuthMethod

public String preferredDataPersistenceAuthMethod()

Get the preferredDataPersistenceAuthMethod property: Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS.

Returns:

the preferredDataPersistenceAuthMethod value.

rdbBackupEnabled

public String rdbBackupEnabled()

Get the rdbBackupEnabled property: Specifies whether the rdb backup is enabled.

Returns:

the rdbBackupEnabled value.

rdbBackupFrequency

public String rdbBackupFrequency()

Get the rdbBackupFrequency property: Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440).

Returns:

the rdbBackupFrequency value.

rdbBackupMaxSnapshotCount

public String rdbBackupMaxSnapshotCount()

Get the rdbBackupMaxSnapshotCount property: Specifies the maximum number of snapshots for rdb backup.

Returns:

the rdbBackupMaxSnapshotCount value.

rdbStorageConnectionString

public String rdbStorageConnectionString()

Get the rdbStorageConnectionString property: The storage account connection string for storing rdb file.

Returns:

the rdbStorageConnectionString value.

storageSubscriptionId

public String storageSubscriptionId()

Get the storageSubscriptionId property: SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.

Returns:

the storageSubscriptionId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAadEnabled

public RedisConfiguration withAadEnabled(String aadEnabled)

Set the aadEnabled property: Specifies whether AAD based authentication has been enabled or disabled for the cache.

Parameters:

aadEnabled - the aadEnabled value to set.

Returns:

the RedisConfiguration object itself.

withAdditionalProperties

public RedisConfiguration withAdditionalProperties(Map additionalProperties)

Set the additionalProperties property: All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the RedisConfiguration object itself.

withAofBackupEnabled

public RedisConfiguration withAofBackupEnabled(String aofBackupEnabled)

Set the aofBackupEnabled property: Specifies whether the aof backup is enabled.

Parameters:

aofBackupEnabled - the aofBackupEnabled value to set.

Returns:

the RedisConfiguration object itself.

withAofStorageConnectionString0

public RedisConfiguration withAofStorageConnectionString0(String aofStorageConnectionString0)

Set the aofStorageConnectionString0 property: First storage account connection string.

Parameters:

aofStorageConnectionString0 - the aofStorageConnectionString0 value to set.

Returns:

the RedisConfiguration object itself.

withAofStorageConnectionString1

public RedisConfiguration withAofStorageConnectionString1(String aofStorageConnectionString1)

Set the aofStorageConnectionString1 property: Second storage account connection string.

Parameters:

aofStorageConnectionString1 - the aofStorageConnectionString1 value to set.

Returns:

the RedisConfiguration object itself.

withAuthnotrequired

public RedisConfiguration withAuthnotrequired(String authnotrequired)

Set the authnotrequired property: Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view.

Parameters:

authnotrequired - the authnotrequired value to set.

Returns:

the RedisConfiguration object itself.

withMaxfragmentationmemoryReserved

public RedisConfiguration withMaxfragmentationmemoryReserved(String maxfragmentationmemoryReserved)

Set the maxfragmentationmemoryReserved property: Value in megabytes reserved for fragmentation per shard.

Parameters:

maxfragmentationmemoryReserved - the maxfragmentationmemoryReserved value to set.

Returns:

the RedisConfiguration object itself.

withMaxmemoryDelta

public RedisConfiguration withMaxmemoryDelta(String maxmemoryDelta)

Set the maxmemoryDelta property: Value in megabytes reserved for non-cache usage per shard e.g. failover.

Parameters:

maxmemoryDelta - the maxmemoryDelta value to set.

Returns:

the RedisConfiguration object itself.

withMaxmemoryPolicy

public RedisConfiguration withMaxmemoryPolicy(String maxmemoryPolicy)

Set the maxmemoryPolicy property: The eviction strategy used when your data won't fit within its memory limit.

Parameters:

maxmemoryPolicy - the maxmemoryPolicy value to set.

Returns:

the RedisConfiguration object itself.

withMaxmemoryReserved

public RedisConfiguration withMaxmemoryReserved(String maxmemoryReserved)

Set the maxmemoryReserved property: Value in megabytes reserved for non-cache usage per shard e.g. failover.

Parameters:

maxmemoryReserved - the maxmemoryReserved value to set.

Returns:

the RedisConfiguration object itself.

withNotifyKeyspaceEvents

public RedisConfiguration withNotifyKeyspaceEvents(String notifyKeyspaceEvents)

Set the notifyKeyspaceEvents property: The keyspace events which should be monitored.

Parameters:

notifyKeyspaceEvents - the notifyKeyspaceEvents value to set.

Returns:

the RedisConfiguration object itself.

withPreferredDataPersistenceAuthMethod

public RedisConfiguration withPreferredDataPersistenceAuthMethod(String preferredDataPersistenceAuthMethod)

Set the preferredDataPersistenceAuthMethod property: Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS.

Parameters:

preferredDataPersistenceAuthMethod - the preferredDataPersistenceAuthMethod value to set.

Returns:

the RedisConfiguration object itself.

withRdbBackupEnabled

public RedisConfiguration withRdbBackupEnabled(String rdbBackupEnabled)

Set the rdbBackupEnabled property: Specifies whether the rdb backup is enabled.

Parameters:

rdbBackupEnabled - the rdbBackupEnabled value to set.

Returns:

the RedisConfiguration object itself.

withRdbBackupFrequency

public RedisConfiguration withRdbBackupFrequency(String rdbBackupFrequency)

Set the rdbBackupFrequency property: Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440).

Parameters:

rdbBackupFrequency - the rdbBackupFrequency value to set.

Returns:

the RedisConfiguration object itself.

withRdbBackupMaxSnapshotCount

public RedisConfiguration withRdbBackupMaxSnapshotCount(String rdbBackupMaxSnapshotCount)

Set the rdbBackupMaxSnapshotCount property: Specifies the maximum number of snapshots for rdb backup.

Parameters:

rdbBackupMaxSnapshotCount - the rdbBackupMaxSnapshotCount value to set.

Returns:

the RedisConfiguration object itself.

withRdbStorageConnectionString

public RedisConfiguration withRdbStorageConnectionString(String rdbStorageConnectionString)

Set the rdbStorageConnectionString property: The storage account connection string for storing rdb file.

Parameters:

rdbStorageConnectionString - the rdbStorageConnectionString value to set.

Returns:

the RedisConfiguration object itself.

withStorageSubscriptionId

public RedisConfiguration withStorageSubscriptionId(String storageSubscriptionId)

Set the storageSubscriptionId property: SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity.

Parameters:

storageSubscriptionId - the storageSubscriptionId value to set.

Returns:

the RedisConfiguration object itself.

zonalConfiguration

public String zonalConfiguration()

Get the zonalConfiguration property: Zonal Configuration.

Returns:

the zonalConfiguration value.

Applies to