From c4451f4898085a2a107ab2b6d7830655aedce9d6 Mon Sep 17 00:00:00 2001 From: "Hong Li(MSFT)" <74638143+v-hongli1@users.noreply.github.com> Date: Thu, 9 Jan 2025 12:07:47 +0800 Subject: [PATCH] Update Javadoc of premium SDK for azure-resourcemanager-servicebus (#43634) --- .../azure-resourcemanager-servicebus/pom.xml | 1 - .../servicebus/ServiceBusManager.java | 2 + .../servicebus/models/AuthorizationKeys.java | 8 ++++ .../servicebus/models/AuthorizationRule.java | 18 +++++++ .../models/CheckNameAvailabilityResult.java | 6 +++ .../models/NamespaceAuthorizationRule.java | 2 + .../servicebus/models/NamespaceSku.java | 6 +++ .../servicebus/models/Queue.java | 48 +++++++++++++++++++ .../models/QueueAuthorizationRule.java | 4 ++ .../models/ServiceBusNamespace.java | 16 +++++++ .../models/ServiceBusSubscription.java | 36 ++++++++++++++ .../servicebus/models/Topic.java | 42 ++++++++++++++++ .../models/TopicAuthorizationRule.java | 4 ++ 13 files changed, 192 insertions(+), 1 deletion(-) diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/pom.xml b/sdk/resourcemanager/azure-resourcemanager-servicebus/pom.xml index ea2fe25910919..ca6d03400ce0e 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/pom.xml +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/pom.xml @@ -45,7 +45,6 @@ --add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED - - diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/ServiceBusManager.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/ServiceBusManager.java index 34f91c3e3c3a9..30fb87b704cb9 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/ServiceBusManager.java +++ b/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() { diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationKeys.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationKeys.java index a0478c13ad7de..ac5132946bdd9 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationKeys.java +++ b/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 { /** + * 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(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationRule.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationRule.java index 5c4708511ff92..733657eb55a37 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationRule.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/AuthorizationRule.java @@ -22,17 +22,23 @@ public interface AuthorizationRule> extends IndependentChildResource, Refreshable { /** + * Gets the rights associated with the rule. + * * @return rights associated with the rule */ List 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 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 { /** + * Enables listening. + * * @return the next stage of the definition */ T withListeningEnabled(); @@ -95,6 +103,8 @@ interface WithListen { */ interface WithSend { /** + * Enables sending. + * * @return the next stage of the definition */ T withSendingEnabled(); @@ -107,6 +117,8 @@ interface WithSend { */ interface WithManage { /** + * Enables management. + * * @return the next stage of the definition */ T withManagementEnabled(); @@ -141,6 +153,8 @@ interface UpdateStages { */ interface WithListen { /** + * Enables the listening. + * * @return the next stage of the update */ T withListeningEnabled(); @@ -153,6 +167,8 @@ interface WithListen { */ interface WithSend { /** + * Enables sending. + * * @return the next stage of the update */ T withSendingEnabled(); @@ -165,6 +181,8 @@ interface WithSend { */ interface WithManage { /** + * Enables management. + * * @return the next stage of the update */ T withManagementEnabled(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/CheckNameAvailabilityResult.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/CheckNameAvailabilityResult.java index 1ce248b915cbc..9fd55c742e1c4 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/CheckNameAvailabilityResult.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/CheckNameAvailabilityResult.java @@ -13,6 +13,8 @@ @Fluent public interface CheckNameAvailabilityResult extends HasInnerModel { /** + * 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. @@ -20,12 +22,16 @@ public interface CheckNameAvailabilityResult extends HasInnerModel, Updatable { /** + * Gets the name of the parent namespace name. + * * @return the name of the parent namespace name */ String namespaceName(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/NamespaceSku.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/NamespaceSku.java index cfc689c9160a2..8ef2c8bdd01da 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/NamespaceSku.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/NamespaceSku.java @@ -58,6 +58,8 @@ public NamespaceSku(SBSku sku) { } /** + * Gets SKU name. + * * @return sku name */ public SkuName name() { @@ -65,6 +67,8 @@ public SkuName name() { } /** + * Gets SKU tier. + * * @return sku tier */ public SkuTier tier() { @@ -72,6 +76,8 @@ public SkuTier tier() { } /** + * Gets SKU capacity. + * * @return sku capacity */ public int capacity() { diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Queue.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Queue.java index 0be31026bf98f..605210e8691b0 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Queue.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Queue.java @@ -22,122 +22,170 @@ public interface Queue extends IndependentChildResource, Refreshable, Updatable { /** + * 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(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/QueueAuthorizationRule.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/QueueAuthorizationRule.java index f6cd71dda46fe..cc8ae1f49cf2e 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/QueueAuthorizationRule.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/QueueAuthorizationRule.java @@ -15,11 +15,15 @@ public interface QueueAuthorizationRule extends AuthorizationRule, Updatable { /** + * 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(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusNamespace.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusNamespace.java index 852fb862367e7..1b6927c73ad5c 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusNamespace.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusNamespace.java @@ -22,41 +22,57 @@ public interface ServiceBusNamespace extends GroupableResource, Refreshable, Updatable { /** + * Gets the relative DNS name of the Service Bus namespace. + * * @return the relative DNS name of the Service Bus namespace */ String dnsLabel(); /** + * Gets the fully qualified domain name (FQDN) of the Service Bus namespace. + * * @return fully qualified domain name (FQDN) of the Service Bus namespace */ String fqdn(); /** + * Gets SKU. + * * @return sku value */ NamespaceSku sku(); /** + * Gets time the namespace was created. + * * @return time the namespace was created */ OffsetDateTime createdAt(); /** + * Gets time the namespace was updated. + * * @return time the namespace was updated */ OffsetDateTime updatedAt(); /** + * Gets entry point to manage queue entities in the Service Bus namespace. + * * @return entry point to manage queue entities in the Service Bus namespace */ Queues queues(); /** + * Gets entry point to manage topics entities in the Service Bus namespace. + * * @return entry point to manage topics entities in the Service Bus namespace */ Topics topics(); /** + * Gets entry point to manage authorization rules for the Service Bus namespace. + * * @return entry point to manage authorization rules for the Service Bus namespace */ NamespaceAuthorizationRules authorizationRules(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusSubscription.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusSubscription.java index 40a624f9ccb1a..5b1f21bfaf1b1 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusSubscription.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/ServiceBusSubscription.java @@ -22,92 +22,128 @@ public interface ServiceBusSubscription extends IndependentChildResource, Refreshable, Updatable { /** + * Gets the exact time the message was created. + * * @return the exact time the message was created */ OffsetDateTime createdAt(); /** + * Gets last time there was a receive request to this subscription. + * * @return last time there was a receive request to this subscription */ OffsetDateTime accessedAt(); /** + * Gets the exact time the message was updated. + * * @return the exact time the message was updated */ OffsetDateTime updatedAt(); /** + * Checks whether server-side batched operations are enabled. + * * @return indicates whether server-side batched operations are enabled */ boolean isBatchedOperationsEnabled(); /** + * Checks whether this subscription has dead letter support when a message expires. + * * @return indicates whether this subscription has dead letter support when a message expires */ boolean isDeadLetteringEnabledForExpiredMessages(); /** + * Checks whether the subscription supports sessions. + * * @return indicates whether the subscription supports sessions */ boolean isSessionEnabled(); /** + * 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 subscription is automatically deleted. + * * @return the idle duration after which the subscription 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 subscription. */ Duration defaultMessageTtlDuration(); /** + * 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 subscription. + * * @return the number of messages in the subscription */ long messageCount(); /** + * Gets number of active messages in the subscription. + * * @return number of active messages in the subscription */ long activeMessageCount(); /** + * Gets number of messages in the dead-letter subscription. + * * @return number of messages in the dead-letter subscription */ long deadLetterMessageCount(); /** + * Gets number of messages sent to the subscription that are yet to be released for consumption. + * * @return number of messages sent to the subscription 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 subscription. + * * @return the current status of the subscription */ EntityStatus status(); /** + * Checks whether subscription has dead letter support on filter evaluation exceptions. + * * @return indicates whether subscription has dead letter support on filter evaluation exceptions */ boolean isDeadLetteringEnabledForFilterEvaluationFailedMessages(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Topic.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Topic.java index 51e2761e0d7c1..fdb4aab36a5a8 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Topic.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/Topic.java @@ -24,107 +24,149 @@ public interface Topic extends IndependentChildResource, HasInnerModel { /** + * Gets the exact time the topic was created. + * * @return the exact time the topic was created */ OffsetDateTime createdAt(); /** + * Gets last time a message was sent, or the last time there was a receive request to this topic. + * * @return last time a message was sent, or the last time there was a receive request to this topic */ OffsetDateTime accessedAt(); /** + * Gets the exact time the topic was updated. + * * @return the exact time the topic was updated */ OffsetDateTime updatedAt(); /** + * Gets the maximum size of memory allocated for the topic in megabytes. + * * @return the maximum size of memory allocated for the topic in megabytes */ long maxSizeInMB(); /** + * Gets current size of the topic. + * * @return current size of the topic, in bytes */ long currentSizeInBytes(); /** + * Checks whether server-side batched operations are enabled. + * * @return indicates whether server-side batched operations are enabled */ boolean isBatchedOperationsEnabled(); /** + * Check whether express entities are enabled. + * * @return indicates whether express entities are enabled */ boolean isExpressEnabled(); /** + * Checks whether the topic is to be partitioned across multiple message brokers. + * * @return indicates whether the topic is to be partitioned across multiple message brokers */ boolean isPartitioningEnabled(); /** + * Checks whether this topic requires duplicate detection. + * * @return indicates if this topic requires duplicate detection */ boolean isDuplicateDetectionEnabled(); /** + * Gets the idle duration after which the topic is automatically deleted. + * * @return the idle duration after which the topic is automatically deleted */ long deleteOnIdleDurationInMinutes(); /** + * Gets the duration after which the message expires, starting from when the message is sent to topic. + * * @return the duration after which the message expires, starting from when the message is sent to topic */ Duration defaultMessageTtlDuration(); /** + * Gets the duration of the duplicate detection history. + * * @return the duration of the duplicate detection history */ Duration duplicateMessageDetectionHistoryDuration(); /** + * Gets number of active messages in the topic. + * * @return number of active messages in the topic */ long activeMessageCount(); /** + * Gets number of messages in the dead-letter topic. + * * @return number of messages in the dead-letter topic */ long deadLetterMessageCount(); /** + * Gets number of messages sent to the topic that are yet to be released for consumption. + * * @return number of messages sent to the topic 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 topic, topic, or subscription. + * * @return number of messages transferred to another topic, topic, or subscription */ long transferMessageCount(); /** + * Gets number of subscriptions for the topic. + * * @return number of subscriptions for the topic */ int subscriptionCount(); /** + * Gets the current status of the topic. + * * @return the current status of the topic */ EntityStatus status(); /** + * Gets entry point to manage subscriptions associated with the topic. + * * @return entry point to manage subscriptions associated with the topic */ ServiceBusSubscriptions subscriptions(); /** + * Gets entry point to manage authorization rules for the Service Bus topic. + * * @return entry point to manage authorization rules for the Service Bus topic */ TopicAuthorizationRules authorizationRules(); diff --git a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/TopicAuthorizationRule.java b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/TopicAuthorizationRule.java index c28fc04e5abdf..abef5e27ea000 100644 --- a/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/TopicAuthorizationRule.java +++ b/sdk/resourcemanager/azure-resourcemanager-servicebus/src/main/java/com/azure/resourcemanager/servicebus/models/TopicAuthorizationRule.java @@ -15,11 +15,15 @@ public interface TopicAuthorizationRule extends AuthorizationRule, Updatable { /** + * Gets the name of the namespace that the parent topic belongs to. + * * @return the name of the namespace that the parent topic belongs to */ String namespaceName(); /** + * Gets the name of the parent topic name. + * * @return the name of the parent topic name */ String topicName();