Skip to content

Commit bc0c8b5

Browse files
v-hongli1v-hongli1
authored
Update Javadoc of premium SDK for azure-resourcemanager-cosmos (#43524)
1 parent 646c075 commit bc0c8b5

File tree

6 files changed

+189
-38
lines changed

6 files changed

+189
-38
lines changed

‎sdk/resourcemanager/azure-resourcemanager-cosmos/pom.xml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
--add-opens com.azure.resourcemanager.cosmos/com.azure.resourcemanager.cosmos=ALL-UNNAMED
4444
--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
4545
</javaModulesSurefireArgLine>
46-
<doclintMissingInclusion>-</doclintMissingInclusion>
4746
</properties>
4847

4948
<developers>

‎sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/CosmosManager.java‎

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

87-
/** @return the cosmos db database account resource management API entry point */
87+
/**
88+
* Gets the cosmos db database account resource management API entry point.
89+
*
90+
* @return the cosmos db database account resource management API entry point
91+
*/
8892
public CosmosDBAccounts databaseAccounts() {
8993
if (databaseAccounts == null) {
9094
databaseAccounts = new CosmosDBAccountsImpl(this);

‎sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/models/CosmosDBAccount.java‎

Lines changed: 149 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,25 @@
2424
public interface CosmosDBAccount extends GroupableResource<CosmosManager, DatabaseAccountGetResultsInner>,
2525
Refreshable<CosmosDBAccount>, Updatable<CosmosDBAccount.Update>, SupportsUpdatingPrivateEndpointConnection {
2626

27-
/** @return indicates the type of database account */
27+
/**
28+
* Gets the type of database account.
29+
*
30+
* @return indicates the type of database account
31+
*/
2832
DatabaseAccountKind kind();
2933

30-
/** @return the connection endpoint for the CosmosDB database account */
34+
/**
35+
* Gets the connection endpoint for the CosmosDB database account.
36+
*
37+
* @return the connection endpoint for the CosmosDB database account
38+
*/
3139
String documentEndpoint();
3240

33-
/** @return the offer type for the CosmosDB database account */
41+
/**
42+
* Gets the offer type for the CosmosDB database account.
43+
*
44+
* @return the offer type for the CosmosDB database account
45+
*/
3446
DatabaseAccountOfferType databaseAccountOfferType();
3547

3648
/**
@@ -41,103 +53,205 @@ public interface CosmosDBAccount extends GroupableResource<CosmosManager, Databa
4153
PublicNetworkAccess publicNetworkAccess();
4254

4355
/**
56+
* Gets specifies the set of IP addresses or IP address ranges in CIDR form.
57+
*
4458
* @return specifies the set of IP addresses or IP address ranges in CIDR form.
4559
* @deprecated use {@link #ipRules()}
4660
*/
4761
@Deprecated
4862
String ipRangeFilter();
4963

50-
/** @return specifies the set of IP addresses or IP address ranges in CIDR form. */
64+
/**
65+
* Gets specifies the set of IP addresses or IP address ranges in CIDR form.
66+
*
67+
* @return specifies the set of IP addresses or IP address ranges in CIDR form.
68+
*/
5169
List<IpAddressOrRange> ipRules();
5270

53-
/** @return the consistency policy for the CosmosDB database account */
71+
/**
72+
* Gets the consistency policy for the CosmosDB database account.
73+
*
74+
* @return the consistency policy for the CosmosDB database account
75+
*/
5476
ConsistencyPolicy consistencyPolicy();
5577

56-
/** @return the default consistency level for the CosmosDB database account */
78+
/**
79+
* Gets the default consistency level for the CosmosDB database account.
80+
*
81+
* @return the default consistency level for the CosmosDB database account
82+
*/
5783
DefaultConsistencyLevel defaultConsistencyLevel();
5884

59-
/** @return an array that contains the writable georeplication locations enabled for the CosmosDB account */
85+
/**
86+
* Gets an array that contains the writable georeplication locations enabled for the CosmosDB account.
87+
*
88+
* @return an array that contains the writable georeplication locations enabled for the CosmosDB account
89+
*/
6090
List<Location> writableReplications();
6191

62-
/** @return an array that contains the readable georeplication locations enabled for the CosmosDB account */
92+
/**
93+
* Gets an array that contains the readable georeplication locations enabled for the CosmosDB account.
94+
*
95+
* @return an array that contains the readable georeplication locations enabled for the CosmosDB account
96+
*/
6397
List<Location> readableReplications();
6498

65-
/** @return the access keys for the specified Azure CosmosDB database account */
99+
/**
100+
* Gets the access keys for the specified Azure CosmosDB database account.
101+
*
102+
* @return the access keys for the specified Azure CosmosDB database account
103+
*/
66104
DatabaseAccountListKeysResult listKeys();
67105

68-
/** @return the access keys for the specified Azure CosmosDB database account */
106+
/**
107+
* Gets the access keys for the specified Azure CosmosDB database account.
108+
*
109+
* @return the access keys for the specified Azure CosmosDB database account
110+
*/
69111
Mono<DatabaseAccountListKeysResult> listKeysAsync();
70112

71-
/** @return the read-only access keys for the specified Azure CosmosDB database account */
113+
/**
114+
* Gets the read-only access keys for the specified Azure CosmosDB database account.
115+
*
116+
* @return the read-only access keys for the specified Azure CosmosDB database account
117+
*/
72118
DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys();
73119

74-
/** @return the read-only access keys for the specified Azure CosmosDB database account */
120+
/**
121+
* Gets the read-only access keys for the specified Azure CosmosDB database account.
122+
*
123+
* @return the read-only access keys for the specified Azure CosmosDB database account
124+
*/
75125
Mono<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync();
76126

77-
/** @return the connection strings for the specified Azure CosmosDB database account */
127+
/**
128+
* Gets the connection strings for the specified Azure CosmosDB database account.
129+
*
130+
* @return the connection strings for the specified Azure CosmosDB database account
131+
*/
78132
DatabaseAccountListConnectionStringsResult listConnectionStrings();
79133

80-
/** @return the connection strings for the specified Azure CosmosDB database account */
134+
/**
135+
* Gets the connection strings for the specified Azure CosmosDB database account.
136+
*
137+
* @return the connection strings for the specified Azure CosmosDB database account
138+
*/
81139
Mono<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync();
82140

83-
/** @return the list of Azure Cosmos DB SQL databases */
141+
/**
142+
* Gets the list of Azure Cosmos DB SQL databases.
143+
*
144+
* @return the list of Azure Cosmos DB SQL databases
145+
*/
84146
List<SqlDatabase> listSqlDatabases();
85147

86-
/** @return the list of Azure Cosmos DB SQL databases */
148+
/**
149+
* Gets the list of Azure Cosmos DB SQL databases.
150+
*
151+
* @return the list of Azure Cosmos DB SQL databases
152+
*/
87153
PagedFlux<SqlDatabase> listSqlDatabasesAsync();
88154

89-
/** @return whether write is enabled for multiple locations or not */
155+
/**
156+
* Checks whether write is enabled for multiple locations.
157+
*
158+
* @return whether write is enabled for multiple locations or not
159+
*/
90160
boolean multipleWriteLocationsEnabled();
91161

92-
/** @return whether cassandra connector is enabled or not. */
162+
/**
163+
* Checks whether cassandra connector is enabled.
164+
*
165+
* @return whether cassandra connector is enabled or not.
166+
*/
93167
boolean cassandraConnectorEnabled();
94168

95-
/** @return the current cassandra connector offer. */
169+
/**
170+
* Gets the current cassandra connector offer.
171+
*
172+
* @return the current cassandra connector offer.
173+
*/
96174
ConnectorOffer cassandraConnectorOffer();
97175

98-
/** @return whether metadata write access is disabled or not. */
176+
/**
177+
* Checks whether metadata write access is disabled.
178+
*
179+
* @return whether metadata write access is disabled or not.
180+
*/
99181
boolean keyBasedMetadataWriteAccessDisabled();
100182

101-
/** @return all private link resources in the account. */
183+
/**
184+
* Gets all private link resources in the account.
185+
*
186+
* @return all private link resources in the account.
187+
*/
102188
PagedFlux<PrivateLinkResource> listPrivateLinkResourcesAsync();
103189

104-
/** @return all private link resources in the account. */
190+
/**
191+
* Gets all private link resources in the account.
192+
*
193+
* @return all private link resources in the account.
194+
*/
105195
List<PrivateLinkResource> listPrivateLinkResources();
106196

107197
/**
198+
* Gets the specific private link resource.
199+
*
108200
* @param groupName group name of private link resource
109-
* @return the specific private link resource group
201+
* @return the specific private link resource
110202
*/
111203
Mono<PrivateLinkResource> getPrivateLinkResourceAsync(String groupName);
112204

113205
/**
206+
* Gets the specific private link resource.
207+
*
114208
* @param groupName group name of private link resource
115-
* @return the specific private link resource group
209+
* @return the specific private link resource
116210
*/
117211
PrivateLinkResource getPrivateLinkResource(String groupName);
118212

119-
/** @return all private endpoint connection in the account. */
213+
/**
214+
* Gets all private endpoint connection in the account.
215+
*
216+
* @return all private endpoint connection in the account.
217+
*/
120218
Mono<Map<String, PrivateEndpointConnection>> listPrivateEndpointConnectionAsync();
121219

122-
/** @return all private endpoint connection in the account. */
220+
/**
221+
* Gets all private endpoint connection in the account.
222+
*
223+
* @return all private endpoint connection in the account.
224+
*/
123225
Map<String, PrivateEndpointConnection> listPrivateEndpointConnection();
124226

125227
/**
228+
* Gets the specific private endpoint connection.
229+
*
126230
* @param name name of private endpoint connection
127231
* @return the specific private endpoint connection
128232
*/
129233
Mono<PrivateEndpointConnection> getPrivateEndpointConnectionAsync(String name);
130234

131235
/**
236+
* Gets the specific private endpoint connection.
237+
*
132238
* @param name name of private endpoint connection
133239
* @return the specific private endpoint connection
134240
*/
135241
PrivateEndpointConnection getPrivateEndpointConnection(String name);
136242

137-
/** @return a list that contains the Cosmos DB capabilities */
243+
/**
244+
* Gets a list that contains the Cosmos DB capabilities.
245+
*
246+
* @return a list that contains the Cosmos DB capabilities
247+
*/
138248
List<Capability> capabilities();
139249

140-
/** @return a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set) */
250+
/**
251+
* Gets a list that contains the Cosmos DB Virtual Network ACL Rules.
252+
*
253+
* @return a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set)
254+
*/
141255
List<VirtualNetworkRule> virtualNetworkRules();
142256

143257
/**
@@ -170,10 +284,16 @@ public interface CosmosDBAccount extends GroupableResource<CosmosManager, Databa
170284
*/
171285
Mono<Void> onlineRegionAsync(Region region);
172286

173-
/** @param keyKind the key kind */
287+
/**
288+
* Regenerates secret keys.
289+
*
290+
* @param keyKind the key kind
291+
*/
174292
void regenerateKey(KeyKind keyKind);
175293

176294
/**
295+
* A deferred emitter that regenerates secret keys.
296+
*
177297
* @param keyKind the key kind
178298
* @return a representation of the deferred computation of this call
179299
*/

‎sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/models/DatabaseAccountListConnectionStringsResult.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
@Fluent
1212
public interface DatabaseAccountListConnectionStringsResult
1313
extends HasInnerModel<DatabaseAccountListConnectionStringsResultInner> {
14-
/** @return a list that contains the connection strings for the CosmosDB account. */
14+
/**
15+
* Gets a list that contains the connection strings for the CosmosDB account.
16+
*
17+
* @return a list that contains the connection strings for the CosmosDB account.
18+
*/
1519
List<DatabaseAccountConnectionString> connectionStrings();
1620
}

‎sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/models/DatabaseAccountListKeysResult.java‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,31 @@
1010
/** An immutable client-side representation of an Azure Cosmos DB DatabaseAccountListKeysResult. */
1111
@Fluent
1212
public interface DatabaseAccountListKeysResult extends HasInnerModel<DatabaseAccountListKeysResultInner> {
13-
/** @return Base 64 encoded value of the primary read-write key. */
13+
/**
14+
* Gets Base 64 encoded value of the primary read-write key..
15+
*
16+
* @return Base 64 encoded value of the primary read-write key.
17+
*/
1418
String primaryMasterKey();
1519

16-
/** @return Base 64 encoded value of the secondary read-write key. */
20+
/**
21+
* Gets Base 64 encoded value of the secondary read-write key.
22+
*
23+
* @return Base 64 encoded value of the secondary read-write key.
24+
*/
1725
String secondaryMasterKey();
1826

19-
/** @return Base 64 encoded value of the primary read-only key. */
27+
/**
28+
* Gets Base 64 encoded value of the primary read-only key.
29+
*
30+
* @return Base 64 encoded value of the primary read-only key.
31+
*/
2032
String primaryReadonlyMasterKey();
2133

22-
/** @return Base 64 encoded value of the secondary read-only key. */
34+
/**
35+
* Gets Base 64 encoded value of the secondary read-only key.
36+
*
37+
* @return Base 64 encoded value of the secondary read-only key.
38+
*/
2339
String secondaryReadonlyMasterKey();
2440
}

‎sdk/resourcemanager/azure-resourcemanager-cosmos/src/main/java/com/azure/resourcemanager/cosmos/models/DatabaseAccountListReadOnlyKeysResult.java‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,17 @@
1010
@Fluent
1111
public interface DatabaseAccountListReadOnlyKeysResult
1212
extends HasInnerModel<DatabaseAccountListReadOnlyKeysResultInner> {
13-
/** @return Base 64 encoded value of the primary read-only key. */
13+
/**
14+
* Gets Base 64 encoded value of the primary read-only key.
15+
*
16+
* @return Base 64 encoded value of the primary read-only key.
17+
*/
1418
String primaryReadonlyMasterKey();
1519

16-
/** @return Base 64 encoded value of the secondary read-only key. */
20+
/**
21+
* Gets Base 64 encoded value of the secondary read-only key.
22+
*
23+
* @return Base 64 encoded value of the secondary read-only key.
24+
*/
1725
String secondaryReadonlyMasterKey();
1826
}

0 commit comments

Comments
 (0)