Class RedisUpdateProperties

java.lang.Object
com.azure.resourcemanager.redis.models.RedisCommonProperties
com.azure.resourcemanager.redis.fluent.models.RedisUpdateProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<RedisCommonProperties>

public final class RedisUpdateProperties extends RedisCommonProperties
Patchable properties of the redis cache.
  • Constructor Details

    • RedisUpdateProperties

      public RedisUpdateProperties()
      Creates an instance of RedisUpdateProperties class.
  • Method Details

    • sku

      public Sku sku()
      Get the sku property: The SKU of the Redis cache to deploy.
      Returns:
      the sku value.
    • withSku

      public RedisUpdateProperties withSku(Sku sku)
      Set the sku property: The SKU of the Redis cache to deploy.
      Parameters:
      sku - the sku value to set.
      Returns:
      the RedisUpdateProperties object itself.
    • withRedisConfiguration

      public RedisUpdateProperties 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.
      Overrides:
      withRedisConfiguration in class RedisCommonProperties
      Parameters:
      redisConfiguration - the redisConfiguration value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withRedisVersion

      public RedisUpdateProperties 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'.
      Overrides:
      withRedisVersion in class RedisCommonProperties
      Parameters:
      redisVersion - the redisVersion value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withEnableNonSslPort

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

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

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

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

      public RedisUpdateProperties withShardCount(Integer shardCount)
      Set the shardCount property: The number of shards to be created on a Premium Cluster Cache.
      Overrides:
      withShardCount in class RedisCommonProperties
      Parameters:
      shardCount - the shardCount value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withMinimumTlsVersion

      public RedisUpdateProperties 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').
      Overrides:
      withMinimumTlsVersion in class RedisCommonProperties
      Parameters:
      minimumTlsVersion - the minimumTlsVersion value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withPublicNetworkAccess

      public RedisUpdateProperties 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'.
      Overrides:
      withPublicNetworkAccess in class RedisCommonProperties
      Parameters:
      publicNetworkAccess - the publicNetworkAccess value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withUpdateChannel

      public RedisUpdateProperties 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'.
      Overrides:
      withUpdateChannel in class RedisCommonProperties
      Parameters:
      updateChannel - the updateChannel value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withDisableAccessKeyAuthentication

      public RedisUpdateProperties withDisableAccessKeyAuthentication(Boolean disableAccessKeyAuthentication)
      Set the disableAccessKeyAuthentication property: Authentication to Redis through access keys is disabled when set as true. Default value is false.
      Overrides:
      withDisableAccessKeyAuthentication in class RedisCommonProperties
      Parameters:
      disableAccessKeyAuthentication - the disableAccessKeyAuthentication value to set.
      Returns:
      the RedisCommonProperties object itself.
    • withZonalAllocationPolicy

      public RedisUpdateProperties 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.
      Overrides:
      withZonalAllocationPolicy in class RedisCommonProperties
      Parameters:
      zonalAllocationPolicy - the zonalAllocationPolicy value to set.
      Returns:
      the RedisCommonProperties object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class RedisCommonProperties
      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>
      Overrides:
      toJson in class RedisCommonProperties
      Throws:
      IOException
    • fromJson

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