Update Javadoc of premium SDK for azure-resourcemanager-eventhubs (#4…

…3602)

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

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

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/EventHubsManager.java

@@ -112,6 +112,8 @@ private EventHubsManager(HttpPipeline httpPipeline, AzureProfile profile) {
     }
 
     /**
+     * Gets entry point to manage EventHub namespaces.
+     *
      * @return entry point to manage EventHub namespaces
      */
     public EventHubNamespaces namespaces() {
@@ -122,6 +124,8 @@ public EventHubNamespaces namespaces() {
     }
 
     /**
+     * Gets entry point to manage event hubs.
+     *
      * @return entry point to manage event hubs
      */
     public EventHubs eventHubs() {
@@ -132,6 +136,8 @@ public EventHubs eventHubs() {
     }
 
     /**
+     * Gets entry point to manage event hub consumer groups.
+     *
      * @return entry point to manage event hub consumer groups
      */
     public EventHubConsumerGroups consumerGroups() {
@@ -142,6 +148,8 @@ public EventHubConsumerGroups consumerGroups() {
     }
 
     /**
+     * Gets entry point to manage disaster recovery pairing of event hub namespaces.
+     *
      * @return entry point to manage disaster recovery pairing of event hub namespaces.
      */
     public EventHubDisasterRecoveryPairings eventHubDisasterRecoveryPairings() {
@@ -152,6 +160,8 @@ public EventHubDisasterRecoveryPairings eventHubDisasterRecoveryPairings() {
     }
 
     /**
+     * Gets entry point to manage event hub authorization rules.
+     *
      * @return entry point to manage event hub authorization rules.
      */
     public EventHubAuthorizationRules eventHubAuthorizationRules() {
@@ -162,6 +172,8 @@ public EventHubAuthorizationRules eventHubAuthorizationRules() {
     }
 
     /**
+     * Gets entry point to manage event hub namespace authorization rules.
+     *
      * @return entry point to manage event hub namespace authorization rules.
      */
     public EventHubNamespaceAuthorizationRules namespaceAuthorizationRules() {
@@ -172,6 +184,8 @@ public EventHubNamespaceAuthorizationRules namespaceAuthorizationRules() {
     }
 
     /**
+     * Gets entry point to manage disaster recovery pairing authorization rules.
+     *
      * @return entry point to manage disaster recovery pairing authorization rules.
      */
     public DisasterRecoveryPairingAuthorizationRules disasterRecoveryPairingAuthorizationRules() {

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

@@ -21,17 +21,23 @@
 public interface AuthorizationRule<RuleT extends AuthorizationRule<RuleT>>
     extends NestedResource, HasInnerModel<AuthorizationRuleInner>, HasManager<EventHubsManager>, Refreshable<RuleT> {
     /**
+     * Gets rights associated with the authorization rule.
+     *
      * @return rights associated with the authorization rule
      */
     List<AccessRights> rights();
 
     /**
+     * Gets a representation of the deferred computation.
+     *
      * @return a representation of the deferred computation of this call,
      * returning access keys (primary, secondary) and the connection strings
      */
     Mono<EventHubAuthorizationKey> getKeysAsync();
 
     /**
+     * Gets the access keys (primary, secondary) and the connection strings.
+     *
      * @return the access keys (primary, secondary) and the connection strings
      */
     EventHubAuthorizationKey getKeys();

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/models/DisasterRecoveryPairingAuthorizationKey.java

@@ -12,31 +12,43 @@
 @Fluent
 public interface DisasterRecoveryPairingAuthorizationKey extends HasInnerModel<AccessKeysInner> {
     /**
+     * Gets primary access key.
+     *
      * @return primary access key
      */
     String primaryKey();
 
     /**
+     * Gets secondary access key.
+     *
      * @return secondary access key
      */
     String secondaryKey();
 
     /**
+     * Gets primary connection string.
+     *
      * @return primary connection string
      */
     String primaryConnectionString();
 
     /**
+     * Gets secondary connection string.
+     *
      * @return secondary connection string
      */
     String secondaryConnectionString();
 
     /**
+     * Gets alias primary connection string.
+     *
      * @return alias primary connection string
      */
     String aliasPrimaryConnectionString();
 
     /**
+     * Gets alias secondary connection string.
+     *
      * @return alias secondary connection string
      */
     String aliasSecondaryConnectionString();

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/models/DisasterRecoveryPairingAuthorizationRule.java

@@ -19,16 +19,22 @@
 public interface DisasterRecoveryPairingAuthorizationRule
     extends HasName, HasInnerModel<AuthorizationRuleInner>, HasManager<EventHubsManager> {
     /**
+     * Gets rights associated with the rule.
+     *
      * @return rights associated with the rule
      */
     List<AccessRights> rights();
 
     /**
+     * Gets an observable that emits a single entity containing access keys (primary and secondary).
+     *
      * @return an observable that emits a single entity containing access keys (primary and secondary)
      */
     Mono<DisasterRecoveryPairingAuthorizationKey> getKeysAsync();
 
     /**
+     * Gets entity containing access keys (primary and secondary).
+     *
      * @return entity containing access keys (primary and secondary)
      */
     DisasterRecoveryPairingAuthorizationKey getKeys();

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/models/EventHub.java

@@ -24,71 +24,99 @@
 public interface EventHub extends NestedResource, HasManager<EventHubsManager>, Refreshable<EventHub>,
     Updatable<EventHub.Update>, HasInnerModel<EventhubInner> {
     /**
+     * Gets the resource group of the parent namespace.
+     *
      * @return the resource group of the parent namespace
      */
     String namespaceResourceGroupName();
 
     /**
+     * Gets name of the parent namespace.
+     *
      * @return name of the parent namespace
      */
     String namespaceName();
 
     /**
+     * Checks whether the data capture enabled for the event hub events.
+     *
      * @return true if the data capture enabled for the event hub events, false otherwise
      */
     boolean isDataCaptureEnabled();
 
     /**
+     * Gets configured window in seconds to be used for event capturing when capturing is enabled.
+     *
      * @return configured window in seconds to be used for event capturing when capturing is enabled
      */
     int dataCaptureWindowSizeInSeconds();
 
     /**
+     * Gets configured window in MB to be used for event capturing when capturing is enabled.
+     *
      * @return configured window in MB to be used for event capturing when capturing is enabled
      */
     int dataCaptureWindowSizeInMB();
 
     /**
+     * Checks whether to skip empty archives when capturing is enabled.
+     *
      * @return whether to skip empty archives when capturing is enabled
      */
     boolean dataCaptureSkipEmptyArchives();
 
     /**
+     * Gets the format file name that stores captured data when capturing is enabled.
+     *
      * @return the format file name that stores captured data when capturing is enabled
      */
     String dataCaptureFileNameFormat();
 
     /**
+     * Gets description of the destination where captured data will be stored.
+     *
      * @return description of the destination where captured data will be stored
      */
     Destination captureDestination();
 
     /**
+     * Gets the partition identifiers.
+     *
      * @return the partition identifiers
      */
     Set<String> partitionIds();
 
     /**
+     * Gets retention period of events in days.
+     *
      * @return retention period of events in days
      */
     int messageRetentionPeriodInDays();
 
     /**
+     * Gets consumer group in the event hub.
+     *
      * @return consumer group in the event hub
      */
     PagedFlux<EventHubConsumerGroup> listConsumerGroupsAsync();
 
     /**
+     * Gets authorization rules enabled for the event hub.
+     *
      * @return authorization rules enabled for the event hub
      */
     PagedFlux<EventHubAuthorizationRule> listAuthorizationRulesAsync();
 
     /**
+     * Gets consumer group in the event hub.
+     *
      * @return consumer group in the event hub
      */
     PagedIterable<EventHubConsumerGroup> listConsumerGroups();
 
     /**
+     * Gets authorization rules enabled for the event hub.
+     *
      * @return authorization rules enabled for the event hub
      */
     PagedIterable<EventHubAuthorizationRule> listAuthorizationRules();

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/models/EventHubAuthorizationKey.java

@@ -12,21 +12,29 @@
 @Fluent
 public interface EventHubAuthorizationKey extends HasInnerModel<AccessKeysInner> {
     /**
+     * Gets primary access key.
+     *
      * @return primary access key
      */
     String primaryKey();
 
     /**
+     * Gets secondary access key.
+     *
      * @return secondary access key
      */
     String secondaryKey();
 
     /**
+     * Gets primary connection string.
+     *
      * @return primary connection string
      */
     String primaryConnectionString();
 
     /**
+     * Gets secondary connection string.
+     *
      * @return secondary connection string
      */
     String secondaryConnectionString();

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/models/EventHubAuthorizationRule.java

@@ -12,16 +12,22 @@
 @Fluent
 public interface EventHubAuthorizationRule extends AuthorizationRule<EventHubAuthorizationRule> {
     /**
+     * Gets the resource group of the namespace where parent event hub resides.
+     *
      * @return the resource group of the namespace where parent event hub resides
      */
     String namespaceResourceGroupName();
 
     /**
+     * Gets the namespace name of parent event hub.
+     *
      * @return the namespace name of parent event hub
      */
     String namespaceName();
 
     /**
+     * Gets the name of the parent event hub.
+     *
      * @return the name of the parent event hub
      */
     String eventHubName();

sdk/resourcemanager/azure-resourcemanager-eventhubs/src/main/java/com/azure/resourcemanager/eventhubs/models/EventHubConsumerGroup.java

@@ -21,31 +21,43 @@
 public interface EventHubConsumerGroup extends NestedResource, HasManager<EventHubsManager>,
     Refreshable<EventHubConsumerGroup>, HasInnerModel<ConsumerGroupInner>, Updatable<EventHubConsumerGroup.Update> {
     /**
+     * Gets the resource group of the namespace where parent event hub resides.
+     *
      * @return the resource group of the namespace where parent event hub resides
      */
     String namespaceResourceGroupName();
 
     /**
+     * Gets the namespace name of parent event hub.
+     *
      * @return the namespace name of parent event hub
      */
     String namespaceName();
 
     /**
+     * Gets the name of the parent event hub.
+     *
      * @return the name of the parent event hub
      */
     String eventHubName();
 
     /**
+     * Gets creation time of the consumer group.
+     *
      * @return creation time of the consumer group
      */
     OffsetDateTime createdAt();
 
     /**
+     * Gets last modified time of the consumer group.
+     *
      * @return last modified time of the consumer group
      */
     OffsetDateTime updatedAt();
 
     /**
+     * Gets user metadata associated with the consumer group.
+     *
      * @return user metadata associated with the consumer group
      */
     String userMetadata();