Class RedisUpdateParameters
java.lang.Object
com.azure.resourcemanager.redis.models.RedisUpdateParameters
- All Implemented Interfaces:
com.azure.json.JsonSerializable<RedisUpdateParameters>
public final class RedisUpdateParameters
extends Object
implements com.azure.json.JsonSerializable<RedisUpdateParameters>
Parameters supplied to the Update Redis operation.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true.Get the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.static RedisUpdateParameters
fromJson
(com.azure.json.JsonReader jsonReader) Reads an instance of RedisUpdateParameters from the JsonReader.identity()
Get the identity property: The identity of the resource.Get the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache.Get the redisConfiguration property: All Redis Settings.Get the redisVersion property: Redis version.Get the replicasPerMaster property: The number of replicas to be created per primary.Get the replicasPerPrimary property: The number of replicas to be created per primary.Get the shardCount property: The number of shards to be created on a Premium Cluster Cache.sku()
Get the sku property: The SKU of the Redis cache to deploy.tags()
Get the tags property: Resource tags.Get the tenantSettings property: A dictionary of tenant settings.com.azure.json.JsonWriter
toJson
(com.azure.json.JsonWriter jsonWriter) Get the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive.void
validate()
Validates the instance.withDisableAccessKeyAuthentication
(Boolean disableAccessKeyAuthentication) Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true.withEnableNonSslPort
(Boolean enableNonSslPort) Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.withIdentity
(ManagedServiceIdentity identity) Set the identity property: The identity of the resource.withMinimumTlsVersion
(TlsVersion minimumTlsVersion) Set the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').withPublicNetworkAccess
(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache.withRedisConfiguration
(RedisConfiguration redisConfiguration) Set the redisConfiguration property: All Redis Settings.withRedisVersion
(String redisVersion) Set the redisVersion property: Redis version.withReplicasPerMaster
(Integer replicasPerMaster) Set the replicasPerMaster property: The number of replicas to be created per primary.withReplicasPerPrimary
(Integer replicasPerPrimary) Set the replicasPerPrimary property: The number of replicas to be created per primary.withShardCount
(Integer shardCount) Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.Set the sku property: The SKU of the Redis cache to deploy.Set the tags property: Resource tags.withTenantSettings
(Map<String, String> tenantSettings) Set the tenantSettings property: A dictionary of tenant settings.withUpdateChannel
(UpdateChannel updateChannel) Set the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive.withZonalAllocationPolicy
(ZonalAllocationPolicy zonalAllocationPolicy) Set the zonalAllocationPolicy property: Optional: Specifies how availability zones are allocated to the Redis cache.Get the zonalAllocationPolicy property: Optional: Specifies how availability zones are allocated to the Redis cache.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
RedisUpdateParameters
public RedisUpdateParameters()Creates an instance of RedisUpdateParameters class.
-
-
Method Details
-
tags
Get the tags property: Resource tags.- Returns:
- the tags value.
-
withTags
Set the tags property: Resource tags.- Parameters:
tags
- the tags value to set.- Returns:
- the RedisUpdateParameters object itself.
-
identity
Get the identity property: The identity of the resource.- Returns:
- the identity value.
-
withIdentity
Set the identity property: The identity of the resource.- Parameters:
identity
- the identity value to set.- Returns:
- the RedisUpdateParameters object itself.
-
sku
Get the sku property: The SKU of the Redis cache to deploy.- Returns:
- the sku value.
-
withSku
Set the sku property: The SKU of the Redis cache to deploy.- Parameters:
sku
- the sku value to set.- Returns:
- the RedisUpdateParameters object itself.
-
redisConfiguration
Get the redisConfiguration 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 redisConfiguration value.
-
withRedisConfiguration
Set the redisConfiguration 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:
redisConfiguration
- the redisConfiguration value to set.- Returns:
- the RedisUpdateParameters object itself.
-
redisVersion
Get the redisVersion property: Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'.- Returns:
- the redisVersion value.
-
withRedisVersion
Set the redisVersion property: Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'.- Parameters:
redisVersion
- the redisVersion value to set.- Returns:
- the RedisUpdateParameters object itself.
-
enableNonSslPort
Get the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.- Returns:
- the enableNonSslPort value.
-
withEnableNonSslPort
Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.- Parameters:
enableNonSslPort
- the enableNonSslPort value to set.- Returns:
- the RedisUpdateParameters object itself.
-
replicasPerMaster
Get the replicasPerMaster property: The number of replicas to be created per primary.- Returns:
- the replicasPerMaster value.
-
withReplicasPerMaster
Set the replicasPerMaster property: The number of replicas to be created per primary.- Parameters:
replicasPerMaster
- the replicasPerMaster value to set.- Returns:
- the RedisUpdateParameters object itself.
-
replicasPerPrimary
Get the replicasPerPrimary property: The number of replicas to be created per primary.- Returns:
- the replicasPerPrimary value.
-
withReplicasPerPrimary
Set the replicasPerPrimary property: The number of replicas to be created per primary.- Parameters:
replicasPerPrimary
- the replicasPerPrimary value to set.- Returns:
- the RedisUpdateParameters object itself.
-
tenantSettings
Get the tenantSettings property: A dictionary of tenant settings.- Returns:
- the tenantSettings value.
-
withTenantSettings
Set the tenantSettings property: A dictionary of tenant settings.- Parameters:
tenantSettings
- the tenantSettings value to set.- Returns:
- the RedisUpdateParameters object itself.
-
shardCount
Get the shardCount property: The number of shards to be created on a Premium Cluster Cache.- Returns:
- the shardCount value.
-
withShardCount
Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.- Parameters:
shardCount
- the shardCount value to set.- Returns:
- the RedisUpdateParameters object itself.
-
minimumTlsVersion
Get the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').- Returns:
- the minimumTlsVersion value.
-
withMinimumTlsVersion
Set the minimumTlsVersion property: Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2').- Parameters:
minimumTlsVersion
- the minimumTlsVersion value to set.- Returns:
- the RedisUpdateParameters object itself.
-
publicNetworkAccess
Get the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
Set the publicNetworkAccess property: Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the RedisUpdateParameters object itself.
-
updateChannel
Get the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'.- Returns:
- the updateChannel value.
-
withUpdateChannel
Set the updateChannel property: Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using 'Preview' update channel get latest Redis updates at least 4 weeks ahead of 'Stable' channel caches. Default value is 'Stable'.- Parameters:
updateChannel
- the updateChannel value to set.- Returns:
- the RedisUpdateParameters object itself.
-
disableAccessKeyAuthentication
Get the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.- Returns:
- the disableAccessKeyAuthentication value.
-
withDisableAccessKeyAuthentication
public RedisUpdateParameters withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication) Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.- Parameters:
disableAccessKeyAuthentication
- the disableAccessKeyAuthentication value to set.- Returns:
- the RedisUpdateParameters object itself.
-
zonalAllocationPolicy
Get the zonalAllocationPolicy property: Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.- Returns:
- the zonalAllocationPolicy value.
-
withZonalAllocationPolicy
Set the zonalAllocationPolicy property: Optional: Specifies how availability zones are allocated to the Redis cache. 'Automatic' enables zone redundancy and Azure will automatically select zones based on regional availability and capacity. 'UserDefined' will select availability zones passed in by you using the 'zones' parameter. 'NoZones' will produce a non-zonal cache. If 'zonalAllocationPolicy' is not passed, it will be set to 'UserDefined' when zones are passed in, otherwise, it will be set to 'Automatic' in regions where zones are supported and 'NoZones' in regions where zones are not supported.- Parameters:
zonalAllocationPolicy
- the zonalAllocationPolicy value to set.- Returns:
- the RedisUpdateParameters object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
toJson
- Specified by:
toJson
in interfacecom.azure.json.JsonSerializable<RedisUpdateParameters>
- Throws:
IOException
-
fromJson
public static RedisUpdateParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of RedisUpdateParameters from the JsonReader.- Parameters:
jsonReader
- The JsonReader being read.- Returns:
- An instance of RedisUpdateParameters 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 RedisUpdateParameters.
-