Skip to content

Commit e92bcf6

Browse files
authored
Update Javadoc of premium SDK for azure-resourcemanager-redis (#43632)
1 parent 9da3182 commit e92bcf6

File tree

4 files changed

+100
-21
lines changed

4 files changed

+100
-21
lines changed

sdk/resourcemanager/azure-resourcemanager-redis/pom.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848

4949
--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
5050
</javaModulesSurefireArgLine>
51-
<doclintMissingInclusion>-</doclintMissingInclusion>
5251
</properties>
5352

5453
<developers>

sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/RedisManager.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,11 @@ private RedisManager(HttpPipeline httpPipeline, AzureProfile profile) {
8585
.buildClient());
8686
}
8787

88-
/** @return the Redis Cache management API entry point */
88+
/**
89+
* Gets the API entry point of the Redis Cache management.
90+
*
91+
* @return the Redis Cache management API entry point
92+
*/
8993
public RedisCaches redisCaches() {
9094
if (redisCaches == null) {
9195
redisCaches = new RedisCachesImpl(this);

sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisAccessKeys.java

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,17 @@
88
/** The <code>RedisCache.keys()</code> action result. */
99
@Fluent
1010
public interface RedisAccessKeys {
11-
/** @return a primary key value. */
11+
/**
12+
* Gets a primary key value.
13+
*
14+
* @return a primary key value.
15+
*/
1216
String primaryKey();
1317

14-
/** @return a secondary key value. */
18+
/**
19+
* Gets a secondary key value.
20+
*
21+
* @return a secondary key value.
22+
*/
1523
String secondaryKey();
1624
}

sdk/resourcemanager/azure-resourcemanager-redis/src/main/java/com/azure/resourcemanager/redis/models/RedisCache.java

Lines changed: 85 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,52 +27,116 @@ public interface RedisCache extends GroupableResource<RedisManager, RedisResourc
2727
Updatable<RedisCache.Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection,
2828
SupportsUpdatingPrivateEndpointConnection {
2929

30-
/** @return exposes features available only to Premium Sku Redis Cache instances. */
30+
/**
31+
* Gets an instance of the Azure Redis cache with Premium SKU.
32+
*
33+
* @return exposes features available only to Premium Sku Redis Cache instances.
34+
*/
3135
RedisCachePremium asPremium();
3236

33-
/** @return returns true if current Redis Cache instance has Premium Sku. */
37+
/**
38+
* Checks whether current Redis Cache instance has Premium Sku.
39+
*
40+
* @return returns true if current Redis Cache instance has Premium Sku.
41+
*/
3442
boolean isPremium();
3543

36-
/** @return the provisioningState value */
44+
/**
45+
* Gets the provisioning state.
46+
*
47+
* @return the provisioningState value
48+
*/
3749
String provisioningState();
3850

39-
/** @return the hostname value */
51+
/**
52+
* Gets the host name.
53+
*
54+
* @return the hostname value
55+
*/
4056
String hostname();
4157

42-
/** @return the port value */
58+
/**
59+
* Gets the port.
60+
*
61+
* @return the port value
62+
*/
4363
int port();
4464

45-
/** @return the sslPort value */
65+
/**
66+
* Gets SSL port.
67+
*
68+
* @return the sslPort value
69+
*/
4670
int sslPort();
4771

48-
/** @return the Redis version value */
72+
/**
73+
* Gets the redis version
74+
*
75+
* @return the Redis version value
76+
*/
4977
String redisVersion();
5078

51-
/** @return the sku value */
79+
/**
80+
* Gets the SKU.
81+
*
82+
* @return the sku value
83+
*/
5284
Sku sku();
5385

54-
/** @return the Redis configuration value */
86+
/**
87+
* Gets the redis configuration.
88+
*
89+
* @return the Redis configuration value
90+
*/
5591
Map<String, String> redisConfiguration();
5692

57-
/** @return true if non SSL port is enabled, false otherwise */
93+
/**
94+
* Checks whether non SSL port is enabled.
95+
*
96+
* @return true if non SSL port is enabled, false otherwise
97+
*/
5898
boolean nonSslPort();
5999

60-
/** @return the shardCount value */
100+
/**
101+
* Gets count of the shard.
102+
*
103+
* @return the shardCount value
104+
*/
61105
int shardCount();
62106

63-
/** @return the subnetId value */
107+
/**
108+
* Gets the resource id of the subnet.
109+
*
110+
* @return the subnetId value
111+
*/
64112
String subnetId();
65113

66-
/** @return the staticIP value */
114+
/**
115+
* Gets the static IP.
116+
*
117+
* @return the staticIP value
118+
*/
67119
String staticIp();
68120

69-
/** @return the minimum TLS version (or higher) that clients require to use. */
121+
/**
122+
* Gets the minimum TLS version (or higher) that clients require to use.
123+
*
124+
* @return the minimum TLS version (or higher) that clients require to use.
125+
*/
70126
TlsVersion minimumTlsVersion();
71127

72-
/** @return Firewall Rules in the Redis Cache, indexed by name */
128+
/**
129+
* Gets firewall rules in the Redis Cache.
130+
*
131+
* @return Firewall Rules in the Redis Cache, indexed by name
132+
*/
73133
Map<String, RedisFirewallRule> firewallRules();
74134

75-
/** @return List of patch schedules for current Redis Cache. */
135+
/**
136+
* Gets list of patch schedules for current Redis Cache.
137+
*
138+
* @return List of patch schedules for current Redis Cache.
139+
*/
76140
List<ScheduleEntry> patchSchedules();
77141

78142
/**
@@ -84,7 +148,11 @@ public interface RedisCache extends GroupableResource<RedisManager, RedisResourc
84148
*/
85149
void forceReboot(RebootType rebootType);
86150

87-
/** @return a Redis Cache's access keys. This operation requires write permission to the Cache resource. */
151+
/**
152+
* Gets a Redis Cache's access keys.
153+
*
154+
* @return a Redis Cache's access keys. This operation requires write permission to the Cache resource.
155+
*/
88156
RedisAccessKeys keys();
89157

90158
/**

0 commit comments

Comments
 (0)