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-sql #43635

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
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-sql/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@
--add-opens com.azure.resourcemanager.msi/com.azure.resourcemanager.msi=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 @@ -41,7 +41,11 @@ protected SqlServerManager(HttpPipeline httpPipeline, AzureProfile profile) {
this.tenantId = profile.getTenantId();
}

/** @return the storage manager in sql manager */
/**
* Gets the storage manager in sql manager.
*
* @return the storage manager in sql manager
*/
public StorageManager storageManager() {
return storageManager;
}
Expand Down Expand Up @@ -101,7 +105,11 @@ public SqlServerManager authenticate(TokenCredential credential, AzureProfile pr
}
}

/** @return the SQL Server management API entry point */
/**
* Gets the API entry point of SQL Server management.
*
* @return the SQL Server management API entry point
*/
public SqlServers sqlServers() {
if (sqlServers == null) {
sqlServers = new SqlServersImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,24 @@
/** The result of checking for the SQL server name availability. */
@Fluent
public interface CheckNameAvailabilityResult extends HasInnerModel<CheckNameAvailabilityResponseInner> {
/** @return true if the specified name is valid and available for use, otherwise false */
/**
* Checks whether the specified name is valid and available for use.
*
* @return true if the specified name is valid and available for use, otherwise false
*/
boolean isAvailable();

/** @return the reason why the user-provided name for the SQL server could not be used */
/**
* Gets the reason why the user-provided name for the SQL server could not be used.
*
* @return the reason why the user-provided name for the SQL server could not be used
*/
String unavailabilityReason();

/** @return the error message that provides more detail for the reason why the name is not available */
/**
* Gets the error message that provides more detail for the reason why the name is not available.
*
* @return the error message that provides more detail for the reason why the name is not available
*/
String unavailabilityMessage();
}
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ public final class DatabaseEdition extends ExpandableStringEnum<DatabaseEdition>
/** Static value Hyperscale for DatabaseEdition. */
public static final DatabaseEdition HYPERSCALE = fromString("Hyperscale");

/**
* Creates a new instance of DatabaseEdition value.
*
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public DatabaseEdition() {
}

/**
* Creates or finds a DatabaseEdition from its string representation.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,45 @@
@Fluent
public interface DatabaseMetric {

/** @return the name of the resource */
/**
* Gets the name of the resource.
*
* @return the name of the resource
*/
String resourceName();

/** @return the metric display name */
/**
* Gets the metric display name.
*
* @return the metric display name
*/
String displayName();

/** @return the current value of the metric */
/**
* Gets the current value of the metric.
*
* @return the current value of the metric
*/
double currentValue();

/** @return the current limit of the metric */
/**
* Gets the current limit of the metric.
*
* @return the current limit of the metric
*/
double limit();

/** @return the units of the metric */
/**
* Gets the units of the metric.
*
* @return the units of the metric
*/
String unit();

/** @return the next reset time for the metric (ISO8601 format) */
/**
* Gets the next reset time for the metric.
*
* @return the next reset time for the metric (ISO8601 format)
*/
OffsetDateTime nextResetTime();
}
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,11 @@ public String toString() {
return String.format("%s/%s/%s/%d/%s", sku.name(), sku.tier(), sku.family(), sku.capacity(), sku.size());
}

/** @return the underneath sku description */
/**
* Gets the underneath sku description.
*
* @return the underneath sku description
*/
@JsonValue
public Sku toSku() {
return new Sku().withName(sku.name())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,80 @@
@Fluent
public interface ElasticPoolActivity
extends HasInnerModel<ElasticPoolOperationInner>, HasResourceGroup, HasName, HasId {
/** @return the time the operation finished (ISO8601 format) */
/**
* Gets the time the operation finished.
*
* @return the time the operation finished (ISO8601 format)
*/
OffsetDateTime endTime();

/** @return the error code if available */
/**
* Gets the error code if available.
*
* @return the error code if available
*/
int errorCode();

/** @return the error message if available */
/**
* Gets the error message if available.
*
* @return the error message if available
*/
String errorMessage();

/** @return the error severity if available */
/**
* Gets the error severity if available.
*
* @return the error severity if available
*/
int errorSeverity();

/** @return the operation name */
/**
* Gets the operation name.
*
* @return the operation name
*/
String operation();

/** @return the unique operation ID */
/**
* Gets the unique operation ID.
*
* @return the unique operation ID
*/
String operationId();

/** @return the percentage complete if available */
/**
* Gets the percentage complete if available.
*
* @return the percentage complete if available
*/
int percentComplete();

/** @return the name of the Elastic Pool */
/**
* Gets the name of the Elastic Pool.
*
* @return the name of the Elastic Pool
*/
String elasticPoolName();

/** @return the name of the Azure SQL Server the Elastic Pool is in */
/**
* Gets the name of the Azure SQL Server the Elastic Pool is in.
*
* @return the name of the Azure SQL Server the Elastic Pool is in
*/
String serverName();

/** @return the time the operation started (ISO8601 format) */
/**
* Gets the time the operation started.
*
* @return the time the operation started (ISO8601 format)
*/
OffsetDateTime startTime();

/** @return the current state of the operation */
/**
* Gets the current state of the operation.
*
* @return the current state of the operation
*/
String state();
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ public final class ElasticPoolEdition extends ExpandableStringEnum<ElasticPoolEd
/** Static value BusinessCritical for ElasticPoolEdition. */
public static final ElasticPoolEdition BUSINESS_CRITICAL = fromString("BusinessCritical");

/**
* Creates a new instance of ElasticPoolEdition value.
*
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public ElasticPoolEdition() {
}

/**
* Creates or finds a ElasticPoolEdition from its string representation.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,11 @@ public String toString() {
return String.format("%s/%s/%s/%d/%s", sku.name(), sku.tier(), sku.family(), sku.capacity(), sku.size());
}

/** @return the underneath sku description */
/**
* Gets the underneath sku description.
*
* @return the underneath sku description
*/
@JsonValue
public Sku toSku() {
return new Sku().withName(sku.name())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,24 @@
/** An immutable client-side representation of an Azure SQL server capabilities for a given region. */
@Fluent
public interface RegionCapabilities extends HasInnerModel<LocationCapabilitiesInner> {
/** @return the location name */
/**
* Gets the location name.
*
* @return the location name
*/
Region region();

/** @return the Azure SQL Database's status for the location */
/**
* Gets the Azure SQL Database's status for the location.
*
* @return the Azure SQL Database's status for the location
*/
CapabilityStatus status();

/** @return the list of supported server versions */
/**
* Gets the list of supported server versions.
*
* @return the list of supported server versions
*/
Map<String, ServerVersionCapability> supportedCapabilitiesByServerVersion();
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,40 +19,88 @@
public interface ReplicationLink
extends Refreshable<ReplicationLink>, HasInnerModel<ReplicationLinkInner>, HasResourceGroup, HasName, HasId {

/** @return name of the SQL Server to which this replication belongs */
/**
* Gets name of the SQL Server to which this replication belongs.
*
* @return name of the SQL Server to which this replication belongs
*/
String sqlServerName();

/** @return name of the SQL Database to which this replication belongs */
/**
* Gets name of the SQL Database to which this replication belongs.
*
* @return name of the SQL Database to which this replication belongs
*/
String databaseName();

/** @return the name of the Azure SQL Server hosting the partner Azure SQL Database. */
/**
* Gets the name of the Azure SQL Server hosting the partner Azure SQL Database.
*
* @return the name of the Azure SQL Server hosting the partner Azure SQL Database.
*/
String partnerServer();

/** @return the name of the partner Azure SQL Database */
/**
* Gets the name of the partner Azure SQL Database.
*
* @return the name of the partner Azure SQL Database
*/
String partnerDatabase();

/** @return the Azure Region of the partner Azure SQL Database */
/**
* Gets the Azure Region of the partner Azure SQL Database.
*
* @return the Azure Region of the partner Azure SQL Database
*/
String partnerLocation();

/** @return the role of the SQL Database in the replication link */
/**
* Gets the role of the SQL Database in the replication link.
*
* @return the role of the SQL Database in the replication link
*/
ReplicationRole role();

/** @return the role of the partner SQL Database in the replication link */
/**
* Gets the role of the partner SQL Database in the replication link.
*
* @return the role of the partner SQL Database in the replication link
*/
ReplicationRole partnerRole();

/** @return start time for the replication link (ISO8601 format) */
/**
* Gets start time for the replication link.
*
* @return start time for the replication link (ISO8601 format)
*/
OffsetDateTime startTime();

/** @return the percentage of the seeding completed for the replication link */
/**
* Gets the percentage of the seeding completed for the replication link.
*
* @return the percentage of the seeding completed for the replication link
*/
int percentComplete();

/** @return the replication state for the replication link */
/**
* Gets the replication state for the replication link.
*
* @return the replication state for the replication link
*/
ReplicationState replicationState();

/** @return the legacy value indicating whether termination is allowed (currently always returns true) */
/**
* Checks whether termination is allowed.
*
* @return the legacy value indicating whether termination is allowed (currently always returns true)
*/
boolean isTerminationAllowed();

/** @return the replication mode of this replication link */
/**
* Gets the replication mode of this replication link.
*
* @return the replication mode of this replication link
*/
String replicationMode();

/** Deletes the replication link. */
Expand Down
Loading
Loading