Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Javadoc of premium SDK for azure-resourcemanager-cosmos #43524

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion sdk/resourcemanager/azure-resourcemanager-cosmos/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
--add-opens com.azure.resourcemanager.cosmos/com.azure.resourcemanager.cosmos=ALL-UNNAMED
--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
</javaModulesSurefireArgLine>
<doclintMissingInclusion>-</doclintMissingInclusion>
</properties>

<developers>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,11 @@ private CosmosManager(HttpPipeline httpPipeline, AzureProfile profile) {
.buildClient());
}

/** @return the cosmos db database account resource management API entry point */
/**
* Gets the cosmos db database account resource management API entry point.
*
* @return the cosmos db database account resource management API entry point
*/
public CosmosDBAccounts databaseAccounts() {
if (databaseAccounts == null) {
databaseAccounts = new CosmosDBAccountsImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,25 @@
public interface CosmosDBAccount extends GroupableResource<CosmosManager, DatabaseAccountGetResultsInner>,
Refreshable<CosmosDBAccount>, Updatable<CosmosDBAccount.Update>, SupportsUpdatingPrivateEndpointConnection {

/** @return indicates the type of database account */
/**
* Gets indicates the type of database account.
v-hongli1 marked this conversation as resolved.
Show resolved Hide resolved
*
* @return indicates the type of database account
*/
DatabaseAccountKind kind();

/** @return the connection endpoint for the CosmosDB database account */
/**
* Gets the connection endpoint for the CosmosDB database account.
*
* @return the connection endpoint for the CosmosDB database account
*/
String documentEndpoint();

/** @return the offer type for the CosmosDB database account */
/**
* Gets the offer type for the CosmosDB database account.
*
* @return the offer type for the CosmosDB database account
*/
DatabaseAccountOfferType databaseAccountOfferType();

/**
Expand All @@ -41,103 +53,206 @@ public interface CosmosDBAccount extends GroupableResource<CosmosManager, Databa
PublicNetworkAccess publicNetworkAccess();

/**
* Gets specifies the set of IP addresses or IP address ranges in CIDR form.
*
* @return specifies the set of IP addresses or IP address ranges in CIDR form.
* @deprecated use {@link #ipRules()}
*/
@Deprecated
String ipRangeFilter();

/** @return specifies the set of IP addresses or IP address ranges in CIDR form. */
/**
* Gets specifies the set of IP addresses or IP address ranges in CIDR form.
*
* @return specifies the set of IP addresses or IP address ranges in CIDR form.
*/
List<IpAddressOrRange> ipRules();

/** @return the consistency policy for the CosmosDB database account */
/**
* Gets the consistency policy for the CosmosDB database account.
*
* @return the consistency policy for the CosmosDB database account
*/
ConsistencyPolicy consistencyPolicy();

/** @return the default consistency level for the CosmosDB database account */
/**
* Gets the default consistency level for the CosmosDB database account.
*
* @return the default consistency level for the CosmosDB database account
*/
DefaultConsistencyLevel defaultConsistencyLevel();

/** @return an array that contains the writable georeplication locations enabled for the CosmosDB account */
/**
* Gets an array that contains the writable georeplication locations enabled for the CosmosDB account.
*
* @return an array that contains the writable georeplication locations enabled for the CosmosDB account
*/
List<Location> writableReplications();

/** @return an array that contains the readable georeplication locations enabled for the CosmosDB account */
/**
* Gets an array that contains the readable georeplication locations enabled for the CosmosDB account.
*
* @return an array that contains the readable georeplication locations enabled for the CosmosDB account
*/
List<Location> readableReplications();

/** @return the access keys for the specified Azure CosmosDB database account */
/**
* Gets the access keys for the specified Azure CosmosDB database account.
*
* @return the access keys for the specified Azure CosmosDB database account
*/
DatabaseAccountListKeysResult listKeys();

/** @return the access keys for the specified Azure CosmosDB database account */
/**
* Gets the access keys for the specified Azure CosmosDB database account.
*
* @return the access keys for the specified Azure CosmosDB database account
*/
Mono<DatabaseAccountListKeysResult> listKeysAsync();

/** @return the read-only access keys for the specified Azure CosmosDB database account */
/**
* Gets the read-only access keys for the specified Azure CosmosDB database account.
*
* @return the read-only access keys for the specified Azure CosmosDB database account
*/
DatabaseAccountListReadOnlyKeysResult listReadOnlyKeys();

/** @return the read-only access keys for the specified Azure CosmosDB database account */
/**
* Gets the read-only access keys for the specified Azure CosmosDB database account.
*
* @return the read-only access keys for the specified Azure CosmosDB database account
*/
Mono<DatabaseAccountListReadOnlyKeysResult> listReadOnlyKeysAsync();

/** @return the connection strings for the specified Azure CosmosDB database account */
/**
* Gets the connection strings for the specified Azure CosmosDB database account.
*
* @return the connection strings for the specified Azure CosmosDB database account
*/
DatabaseAccountListConnectionStringsResult listConnectionStrings();

/** @return the connection strings for the specified Azure CosmosDB database account */
/**
* Gets the connection strings for the specified Azure CosmosDB database account.
*
* @return the connection strings for the specified Azure CosmosDB database account
*/
Mono<DatabaseAccountListConnectionStringsResult> listConnectionStringsAsync();

/** @return the list of Azure Cosmos DB SQL databases */
/**
* Gets the list of Azure Cosmos DB SQL databases.
*
* @return the list of Azure Cosmos DB SQL databases
*/
List<SqlDatabase> listSqlDatabases();

/** @return the list of Azure Cosmos DB SQL databases */
/**
* Gets the list of Azure Cosmos DB SQL databases.
*
* @return the list of Azure Cosmos DB SQL databases
*/
PagedFlux<SqlDatabase> listSqlDatabasesAsync();

/** @return whether write is enabled for multiple locations or not */
/**
* Check whether write is enabled for multiple locations.
*
* @return whether write is enabled for multiple locations or not
*/
boolean multipleWriteLocationsEnabled();

/** @return whether cassandra connector is enabled or not. */
/**
* CHeck whether cassandra connector is enabled.
v-hongli1 marked this conversation as resolved.
Show resolved Hide resolved
*
* @return whether cassandra connector is enabled or not.
*/
boolean cassandraConnectorEnabled();

/** @return the current cassandra connector offer. */
/**
* Gets the current cassandra connector offer.
*
* @return the current cassandra connector offer.
*/
ConnectorOffer cassandraConnectorOffer();

/** @return whether metadata write access is disabled or not. */
/**
* Check whether metadata write access is disabled.
v-hongli1 marked this conversation as resolved.
Show resolved Hide resolved
*
* @return whether metadata write access is disabled or not.
*/
boolean keyBasedMetadataWriteAccessDisabled();

/** @return all private link resources in the account. */
/**
* Gets all private link resources in the account.
*
* @return all private link resources in the account.
*/
PagedFlux<PrivateLinkResource> listPrivateLinkResourcesAsync();

/** @return all private link resources in the account. */
/**
* Gets all private link resources in the account.
*
* @return all private link resources in the account.
*/
List<PrivateLinkResource> listPrivateLinkResources();

/**
* Gets the specific private link resource group.
*
* @param groupName group name of private link resource
* @return the specific private link resource group
*/
weidongxu-microsoft marked this conversation as resolved.
Show resolved Hide resolved
Mono<PrivateLinkResource> getPrivateLinkResourceAsync(String groupName);

/**
* Gets the specific private link resource group.
*
*
weidongxu-microsoft marked this conversation as resolved.
Show resolved Hide resolved
* @param groupName group name of private link resource
* @return the specific private link resource group
weidongxu-microsoft marked this conversation as resolved.
Show resolved Hide resolved
*/
PrivateLinkResource getPrivateLinkResource(String groupName);

/** @return all private endpoint connection in the account. */
/**
* Gets all private endpoint connection in the account.
*
* @return all private endpoint connection in the account.
*/
Mono<Map<String, PrivateEndpointConnection>> listPrivateEndpointConnectionAsync();

/** @return all private endpoint connection in the account. */
/**
* Gets all private endpoint connection in the account.
*
* @return all private endpoint connection in the account.
*/
Map<String, PrivateEndpointConnection> listPrivateEndpointConnection();

/**
* Gets the specific private endpoint connection.
*
* @param name name of private endpoint connection
* @return the specific private endpoint connection
*/
Mono<PrivateEndpointConnection> getPrivateEndpointConnectionAsync(String name);

/**
* Gets the specific private endpoint connection.
*
* @param name name of private endpoint connection
* @return the specific private endpoint connection
*/
PrivateEndpointConnection getPrivateEndpointConnection(String name);

/** @return a list that contains the Cosmos DB capabilities */
/**
* Gets a list that contains the Cosmos DB capabilities.
*
* @return a list that contains the Cosmos DB capabilities
*/
List<Capability> capabilities();

/** @return a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set) */
/**
* Gets a list that contains the Cosmos DB Virtual Network ACL Rules.
*
* @return a list that contains the Cosmos DB Virtual Network ACL Rules (empty list if none is set)
*/
List<VirtualNetworkRule> virtualNetworkRules();

/**
Expand Down Expand Up @@ -170,10 +285,16 @@ public interface CosmosDBAccount extends GroupableResource<CosmosManager, Databa
*/
Mono<Void> onlineRegionAsync(Region region);

/** @param keyKind the key kind */
/**
* Regenerates secret keys.
*
* @param keyKind the key kind
*/
void regenerateKey(KeyKind keyKind);

/**
* Gets a representation of the deferred computation of this call.
weidongxu-microsoft marked this conversation as resolved.
Show resolved Hide resolved
*
* @param keyKind the key kind
* @return a representation of the deferred computation of this call
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
@Fluent
public interface DatabaseAccountListConnectionStringsResult
extends HasInnerModel<DatabaseAccountListConnectionStringsResultInner> {
/** @return a list that contains the connection strings for the CosmosDB account. */
/**
* Gets a list that contains the connection strings for the CosmosDB account.
*
* @return a list that contains the connection strings for the CosmosDB account.
*/
List<DatabaseAccountConnectionString> connectionStrings();
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,31 @@
/** An immutable client-side representation of an Azure Cosmos DB DatabaseAccountListKeysResult. */
@Fluent
public interface DatabaseAccountListKeysResult extends HasInnerModel<DatabaseAccountListKeysResultInner> {
/** @return Base 64 encoded value of the primary read-write key. */
/**
* Gets Base 64 encoded value of the primary read-write key..
*
* @return Base 64 encoded value of the primary read-write key.
*/
String primaryMasterKey();

/** @return Base 64 encoded value of the secondary read-write key. */
/**
* Gets Base 64 encoded value of the secondary read-write key.
*
* @return Base 64 encoded value of the secondary read-write key.
*/
String secondaryMasterKey();

/** @return Base 64 encoded value of the primary read-only key. */
/**
* Gets Base 64 encoded value of the primary read-only key.
*
* @return Base 64 encoded value of the primary read-only key.
*/
String primaryReadonlyMasterKey();

/** @return Base 64 encoded value of the secondary read-only key. */
/**
* Gets Base 64 encoded value of the secondary read-only key.
*
* @return Base 64 encoded value of the secondary read-only key.
*/
String secondaryReadonlyMasterKey();
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,17 @@
@Fluent
public interface DatabaseAccountListReadOnlyKeysResult
extends HasInnerModel<DatabaseAccountListReadOnlyKeysResultInner> {
/** @return Base 64 encoded value of the primary read-only key. */
/**
* Gets Base 64 encoded value of the primary read-only key.
*
* @return Base 64 encoded value of the primary read-only key.
*/
String primaryReadonlyMasterKey();

/** @return Base 64 encoded value of the secondary read-only key. */
/**
* Gets Base 64 encoded value of the secondary read-only key.
*
* @return Base 64 encoded value of the secondary read-only key.
*/
String secondaryReadonlyMasterKey();
}
Loading