From e92bcf62d522a03b97c3c8fc151f6b7adc85de4d Mon Sep 17 00:00:00 2001
From: "Hong Li(MSFT)" <74638143+v-hongli1@users.noreply.github.com>
Date: Thu, 9 Jan 2025 08:24:45 +0800
Subject: [PATCH] Update Javadoc of premium SDK for azure-resourcemanager-redis
(#43632)
---
.../azure-resourcemanager-redis/pom.xml | 1 -
.../resourcemanager/redis/RedisManager.java | 6 +-
.../redis/models/RedisAccessKeys.java | 12 ++-
.../redis/models/RedisCache.java | 102 +++++++++++++++---
4 files changed, 100 insertions(+), 21 deletions(-)
diff --git a/sdk/resourcemanager/azure-resourcemanager-redis/pom.xml b/sdk/resourcemanager/azure-resourcemanager-redis/pom.xml
index 13663d42f4803..ae8fd9c777a21 100644
--- a/sdk/resourcemanager/azure-resourcemanager-redis/pom.xml
+++ b/sdk/resourcemanager/azure-resourcemanager-redis/pom.xml
@@ -48,7 +48,6 @@
--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
- -
diff --git a/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/RedisManager.java b/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/RedisManager.java
index 221ff38b3b3fa..117fb9596738b 100644
--- a/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/RedisManager.java
+++ b/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/RedisManager.java
@@ -85,7 +85,11 @@ private RedisManager(HttpPipeline httpPipeline, AzureProfile profile) {
.buildClient());
}
- /** @return the Redis Cache management API entry point */
+ /**
+ * Gets the API entry point of the Redis Cache management.
+ *
+ * @return the Redis Cache management API entry point
+ */
public RedisCaches redisCaches() {
if (redisCaches == null) {
redisCaches = new RedisCachesImpl(this);
diff --git a/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisAccessKeys.java b/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisAccessKeys.java
index 7f383bdf9539b..d8ea9a7b3105b 100644
--- a/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisAccessKeys.java
+++ b/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisAccessKeys.java
@@ -8,9 +8,17 @@
/** The RedisCache.keys()
action result. */
@Fluent
public interface RedisAccessKeys {
- /** @return a primary key value. */
+ /**
+ * Gets a primary key value.
+ *
+ * @return a primary key value.
+ */
String primaryKey();
- /** @return a secondary key value. */
+ /**
+ * Gets a secondary key value.
+ *
+ * @return a secondary key value.
+ */
String secondaryKey();
}
diff --git a/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisCache.java b/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisCache.java
index 8131a1ae5a9df..e521588c5ea96 100644
--- a/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisCache.java
+++ b/sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisCache.java
@@ -27,52 +27,116 @@ public interface RedisCache extends GroupableResource, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection,
SupportsUpdatingPrivateEndpointConnection {
- /** @return exposes features available only to Premium Sku Redis Cache instances. */
+ /**
+ * Gets an instance of the Azure Redis cache with Premium SKU.
+ *
+ * @return exposes features available only to Premium Sku Redis Cache instances.
+ */
RedisCachePremium asPremium();
- /** @return returns true if current Redis Cache instance has Premium Sku. */
+ /**
+ * Checks whether current Redis Cache instance has Premium Sku.
+ *
+ * @return returns true if current Redis Cache instance has Premium Sku.
+ */
boolean isPremium();
- /** @return the provisioningState value */
+ /**
+ * Gets the provisioning state.
+ *
+ * @return the provisioningState value
+ */
String provisioningState();
- /** @return the hostname value */
+ /**
+ * Gets the host name.
+ *
+ * @return the hostname value
+ */
String hostname();
- /** @return the port value */
+ /**
+ * Gets the port.
+ *
+ * @return the port value
+ */
int port();
- /** @return the sslPort value */
+ /**
+ * Gets SSL port.
+ *
+ * @return the sslPort value
+ */
int sslPort();
- /** @return the Redis version value */
+ /**
+ * Gets the redis version
+ *
+ * @return the Redis version value
+ */
String redisVersion();
- /** @return the sku value */
+ /**
+ * Gets the SKU.
+ *
+ * @return the sku value
+ */
Sku sku();
- /** @return the Redis configuration value */
+ /**
+ * Gets the redis configuration.
+ *
+ * @return the Redis configuration value
+ */
Map redisConfiguration();
- /** @return true if non SSL port is enabled, false otherwise */
+ /**
+ * Checks whether non SSL port is enabled.
+ *
+ * @return true if non SSL port is enabled, false otherwise
+ */
boolean nonSslPort();
- /** @return the shardCount value */
+ /**
+ * Gets count of the shard.
+ *
+ * @return the shardCount value
+ */
int shardCount();
- /** @return the subnetId value */
+ /**
+ * Gets the resource id of the subnet.
+ *
+ * @return the subnetId value
+ */
String subnetId();
- /** @return the staticIP value */
+ /**
+ * Gets the static IP.
+ *
+ * @return the staticIP value
+ */
String staticIp();
- /** @return the minimum TLS version (or higher) that clients require to use. */
+ /**
+ * Gets the minimum TLS version (or higher) that clients require to use.
+ *
+ * @return the minimum TLS version (or higher) that clients require to use.
+ */
TlsVersion minimumTlsVersion();
- /** @return Firewall Rules in the Redis Cache, indexed by name */
+ /**
+ * Gets firewall rules in the Redis Cache.
+ *
+ * @return Firewall Rules in the Redis Cache, indexed by name
+ */
Map firewallRules();
- /** @return List of patch schedules for current Redis Cache. */
+ /**
+ * Gets list of patch schedules for current Redis Cache.
+ *
+ * @return List of patch schedules for current Redis Cache.
+ */
List patchSchedules();
/**
@@ -84,7 +148,11 @@ public interface RedisCache extends GroupableResource