Update Javadoc of premium SDK for azure-resourcemanager-servicebus (#43634)

Author: v-hongli1

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

@@ -45,7 +45,6 @@
 
       --add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
     </javaModulesSurefireArgLine>
-    <doclintMissingInclusion>-</doclintMissingInclusion>
   </properties>
 
   <developers>

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/ServiceBusManager.java

@@ -93,6 +93,8 @@ private ServiceBusManager(HttpPipeline httpPipeline, AzureProfile profile) {
     }
 
     /**
+     * Gets the API entry point of the Service Bus namespace management.
+     *
      * @return the Service Bus namespace management API entry point
      */
     public ServiceBusNamespaces namespaces() {

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationKeys.java

@@ -13,21 +13,29 @@
 @Fluent
 public interface AuthorizationKeys extends HasInnerModel<AccessKeysInner> {
     /**
+     * Gets the primary key associated with the rule.
+     *
      * @return primary key associated with the rule
      */
     String primaryKey();
 
     /**
+     * Gets the secondary key associated with the rule.
+     *
      * @return secondary key associated with the rule
      */
     String secondaryKey();
 
     /**
+     * Gets the primary connection string.
+     *
      * @return primary connection string
      */
     String primaryConnectionString();
 
     /**
+     * Gets the secondary connection string.
+     *
      * @return secondary connection string
      */
     String secondaryConnectionString();

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationRule.java

@@ -22,17 +22,23 @@ public interface AuthorizationRule<RuleT extends AuthorizationRule<RuleT>>
     extends IndependentChildResource<ServiceBusManager, SBAuthorizationRuleInner>, Refreshable<RuleT> {
 
     /**
+     * Gets the rights associated with the rule.
+     *
      * @return rights associated with the rule
      */
     List<AccessRights> rights();
 
     /**
+     * Gets a representation of the deferred computation.
+     *
      * @return a representation of the deferred computation of this call,
      * returning the primary, secondary keys and the connection strings
      */
     Mono<AuthorizationKeys> getKeysAsync();
 
     /**
+     * Gets the primary, secondary keys and connection strings.
+     *
      * @return the primary, secondary keys and connection strings
      */
     AuthorizationKeys getKeys();
@@ -83,6 +89,8 @@ interface DefinitionStages {
          */
         interface WithListen<T> {
             /**
+             * Enables listening.
+             *
              * @return the next stage of the definition
              */
             T withListeningEnabled();
@@ -95,6 +103,8 @@ interface WithListen<T> {
          */
         interface WithSend<T> {
             /**
+             * Enables sending.
+             *
              * @return the next stage of the definition
              */
             T withSendingEnabled();
@@ -107,6 +117,8 @@ interface WithSend<T> {
          */
         interface WithManage<T> {
             /**
+             * Enables management.
+             *
              * @return the next stage of the definition
              */
             T withManagementEnabled();
@@ -141,6 +153,8 @@ interface UpdateStages {
          */
         interface WithListen<T> {
             /**
+             * Enables the listening.
+             *
              * @return the next stage of the update
              */
             T withListeningEnabled();
@@ -153,6 +167,8 @@ interface WithListen<T> {
          */
         interface WithSend<T> {
             /**
+             * Enables sending.
+             *
              * @return the next stage of the update
              */
             T withSendingEnabled();
@@ -165,6 +181,8 @@ interface WithSend<T> {
          */
         interface WithManage<T> {
             /**
+             * Enables management.
+             *
              * @return the next stage of the update
              */
             T withManagementEnabled();

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/CheckNameAvailabilityResult.java

@@ -13,19 +13,25 @@
 @Fluent
 public interface CheckNameAvailabilityResult extends HasInnerModel<CheckNameAvailabilityResultInner> {
     /**
+     * Gets a boolean value that indicates whether the name is available for you to use.
+     *
      * @return a boolean value that indicates whether the name is available for
      * you to use. If true, the name is available. If false, the name has
      * already been taken or invalid and cannot be used.
      */
     boolean isAvailable();
 
     /**
+     * Gets the unavailabilityReason that a namespace name could not be used.
+     *
      * @return the unavailabilityReason that a namespace name could not be used. The
      * Reason element is only returned if NameAvailable is false.
      */
     UnavailableReason unavailabilityReason();
 
     /**
+     * Gets an error message explaining the Reason value in more detail.
+     *
      * @return an error message explaining the Reason value in more detail
      */
     String unavailabilityMessage();

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/NamespaceAuthorizationRule.java

@@ -15,6 +15,8 @@
 public interface NamespaceAuthorizationRule
     extends AuthorizationRule<NamespaceAuthorizationRule>, Updatable<NamespaceAuthorizationRule.Update> {
     /**
+     * Gets the name of the parent namespace name.
+     *
      * @return the name of the parent namespace name
      */
     String namespaceName();

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/NamespaceSku.java

@@ -58,20 +58,26 @@ public NamespaceSku(SBSku sku) {
     }
 
     /**
+     * Gets SKU name.
+     *
      * @return sku name
      */
     public SkuName name() {
         return this.sku.name();
     }
 
     /**
+     * Gets SKU tier.
+     *
      * @return sku tier
      */
     public SkuTier tier() {
         return this.sku.tier();
     }
 
     /**
+     * Gets SKU capacity.
+     *
      * @return sku capacity
      */
     public int capacity() {

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Queue.java

@@ -22,122 +22,170 @@
 public interface Queue
     extends IndependentChildResource<ServiceBusManager, SBQueueInner>, Refreshable<Queue>, Updatable<Queue.Update> {
     /**
+     * Gets the exact time the queue was created.
+     *
      * @return the exact time the queue was created
      */
     OffsetDateTime createdAt();
 
     /**
+     * Gets last time a message was sent, or the last time there was a receive request to this queue.
+     *
      * @return last time a message was sent, or the last time there was a receive request to this queue
      */
     OffsetDateTime accessedAt();
 
     /**
+     * Gets the exact time the queue was updated.
+     *
      * @return the exact time the queue was updated
      */
     OffsetDateTime updatedAt();
 
     /**
+     * Gets the maximum size of memory allocated for the queue in megabytes.
+     *
      * @return the maximum size of memory allocated for the queue in megabytes
      */
     long maxSizeInMB();
 
     /**
+     * Gets current size of the queue.
+     *
      * @return current size of the queue, in bytes
      */
     long currentSizeInBytes();
 
     /**
+     * Checks whether server-side batched operations are enabled.
+     *
      * @return indicates whether server-side batched operations are enabled
      */
     boolean isBatchedOperationsEnabled();
 
     /**
+     * Checks whether this queue has dead letter support when a message expires.
+     *
      * @return indicates whether this queue has dead letter support when a message expires
      */
     boolean isDeadLetteringEnabledForExpiredMessages();
 
     /**
+     * Checks whether express entities are enabled.
+     *
      * @return indicates whether express entities are enabled
      */
     boolean isExpressEnabled();
 
     /**
+     * Checks whether the queue is to be partitioned across multiple message brokers.
+     *
      * @return indicates whether the queue is to be partitioned across multiple message brokers
      */
     boolean isPartitioningEnabled();
 
     /**
+     * Checks whether the queue supports sessions.
+     *
      * @return indicates whether the queue supports sessions
      */
     boolean isSessionEnabled();
 
     /**
+     * Checks whether this queue requires duplicate detection.
+     *
      * @return indicates if this queue requires duplicate detection
      */
     boolean isDuplicateDetectionEnabled();
 
     /**
+     * Gets the duration of peek-lock which is the amount of time that the message is locked for other receivers.
+     *
      * @return the duration of peek-lock which is the amount of time that the message is locked for other receivers
      */
     long lockDurationInSeconds();
 
     /**
+     * Gets the idle duration after which the queue is automatically deleted.
+     *
      * @return the idle duration after which the queue is automatically deleted
      */
     long deleteOnIdleDurationInMinutes();
 
     /**
+     * Gets the duration after which the message expires.
+     *
      * @return the duration after which the message expires, starting from when the message is sent to queue
      */
     Duration defaultMessageTtlDuration();
 
     /**
+     * GEts the duration of the duplicate detection history.
+     *
      * @return the duration of the duplicate detection history
      */
     Duration duplicateMessageDetectionHistoryDuration();
 
     /**
+     * Gets the maximum number of a message delivery before marking it as dead-lettered.
+     *
      * @return the maximum number of a message delivery before marking it as dead-lettered
      */
     int maxDeliveryCountBeforeDeadLetteringMessage();
 
     /**
+     * Gets the number of messages in the queue.
+     *
      * @return the number of messages in the queue
      */
     long messageCount();
 
     /**
+     * Gets number of active messages in the queue.
+     *
      * @return number of active messages in the queue
      */
     long activeMessageCount();
 
     /**
+     * Gets number of messages in the dead-letter queue.
+     *
      * @return number of messages in the dead-letter queue
      */
     long deadLetterMessageCount();
 
     /**
+     * Gets number of messages sent to the queue that are yet to be released for consumption
+     *
      * @return number of messages sent to the queue that are yet to be released
      * for consumption
      */
     long scheduledMessageCount();
 
     /**
+     * Gets number of messages transferred into dead letters.
+     *
      * @return number of messages transferred into dead letters
      */
     long transferDeadLetterMessageCount();
 
     /**
+     * Gets number of messages transferred to another queue, topic, or subscription.
+     *
      * @return number of messages transferred to another queue, topic, or subscription
      */
     long transferMessageCount();
 
     /**
+     * Gets the current status of the queue.
+     *
      * @return the current status of the queue
      */
     EntityStatus status();
 
     /**
+     * Gets entry point to manage authorization rules for the Service Bus queue.
+     *
      * @return entry point to manage authorization rules for the Service Bus queue
      */
     QueueAuthorizationRules authorizationRules();

sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/QueueAuthorizationRule.java

@@ -15,11 +15,15 @@
 public interface QueueAuthorizationRule
     extends AuthorizationRule<QueueAuthorizationRule>, Updatable<QueueAuthorizationRule.Update> {
     /**
+     * Gets the name of the namespace that the parent queue belongs to.
+     *
      * @return the name of the namespace that the parent queue belongs to
      */
     String namespaceName();
 
     /**
+     * Gets the name of the parent queue name.
+     *
      * @return the name of the parent queue name
      */
     String queueName();