Package com.azure.resourcemanager.redis.models

Class RedisCommonProperties

java.lang.Object
com.azure.resourcemanager.redis.models.RedisCommonProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<RedisCommonProperties>
Direct Known Subclasses:
RedisCreateProperties, RedisUpdateProperties
public class RedisCommonProperties extends Object implements com.azure.json.JsonSerializable<RedisCommonProperties>
Create/Update/Get common properties of the redis cache.

  • Constructor Details

    • RedisCommonProperties

      public RedisCommonProperties()
      Creates an instance of RedisCommonProperties class.

  • Method Details

    • redisConfiguration

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

      public RedisCommonProperties withRedisConfiguration(RedisConfiguration redisConfiguration)
      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 RedisCommonProperties object itself.

    • redisVersion

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

      public RedisCommonProperties withRedisVersion(String redisVersion)
      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 RedisCommonProperties object itself.

    • enableNonSslPort

      public Boolean enableNonSslPort()
      Get the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.
      Returns:
      the enableNonSslPort value.

    • withEnableNonSslPort

      public RedisCommonProperties withEnableNonSslPort(Boolean enableNonSslPort)
      Set the enableNonSslPort property: Specifies whether the non-ssl Redis server port (6379) is enabled.
      Parameters:
      enableNonSslPort - the enableNonSslPort value to set.
      Returns:
      the RedisCommonProperties object itself.

    • replicasPerMaster

      public Integer replicasPerMaster()
      Get the replicasPerMaster property: The number of replicas to be created per primary.
      Returns:
      the replicasPerMaster value.

    • withReplicasPerMaster

      public RedisCommonProperties withReplicasPerMaster(Integer replicasPerMaster)
      Set the replicasPerMaster property: The number of replicas to be created per primary.
      Parameters:
      replicasPerMaster - the replicasPerMaster value to set.
      Returns:
      the RedisCommonProperties object itself.

    • replicasPerPrimary

      public Integer replicasPerPrimary()
      Get the replicasPerPrimary property: The number of replicas to be created per primary.
      Returns:
      the replicasPerPrimary value.

    • withReplicasPerPrimary

      public RedisCommonProperties withReplicasPerPrimary(Integer replicasPerPrimary)
      Set the replicasPerPrimary property: The number of replicas to be created per primary.
      Parameters:
      replicasPerPrimary - the replicasPerPrimary value to set.
      Returns:
      the RedisCommonProperties object itself.

    • tenantSettings

      public Map<String,String> tenantSettings()
      Get the tenantSettings property: A dictionary of tenant settings.
      Returns:
      the tenantSettings value.

    • withTenantSettings

      public RedisCommonProperties withTenantSettings(Map<String,String> tenantSettings)
      Set the tenantSettings property: A dictionary of tenant settings.
      Parameters:
      tenantSettings - the tenantSettings value to set.
      Returns:
      the RedisCommonProperties object itself.

    • shardCount

      public Integer shardCount()
      Get the shardCount property: The number of shards to be created on a Premium Cluster Cache.
      Returns:
      the shardCount value.

    • withShardCount

      public RedisCommonProperties withShardCount(Integer shardCount)
      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 RedisCommonProperties object itself.

    • minimumTlsVersion

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

      public RedisCommonProperties 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').
      Parameters:
      minimumTlsVersion - the minimumTlsVersion value to set.
      Returns:
      the RedisCommonProperties object itself.

    • publicNetworkAccess

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

      public RedisCommonProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
      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 RedisCommonProperties object itself.

    • updateChannel

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

      public RedisCommonProperties withUpdateChannel(UpdateChannel updateChannel)
      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 RedisCommonProperties object itself.

    • disableAccessKeyAuthentication

      public Boolean 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 RedisCommonProperties 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 RedisCommonProperties object itself.

    • zonalAllocationPolicy

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

      public RedisCommonProperties withZonalAllocationPolicy(ZonalAllocationPolicy zonalAllocationPolicy)
      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 RedisCommonProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<RedisCommonProperties>
      Throws:
      IOException

    • fromJson

      public static RedisCommonProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RedisCommonProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RedisCommonProperties 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 RedisCommonProperties.