[Service Bus] Description -> Properties (#10114)

sdk/servicebus/service-bus/CHANGELOG.md

@@ -21,7 +21,7 @@
 - `userProperties` attribute under the `ServiceBusMessage`(and `ReceivedMessage`, `ReceivedMessageWithLock`) has been renamed to `properties`. Same change has been made to the `userProperties` attribute in the correlation-rule filter.
   [PR 10003](https://github.com/Azure/azure-sdk-for-js/pull/10003)
 
-- The term `RuntimeInfo` is replaced with `RuntimeProperties` to better align with guidelines around the kind of suffixes we use for naming methods and interfaces.
+- The terms `RuntimeInfo` and `Description` are replaced with `RuntimeProperties` and `Properties` to better align with guidelines around the kind of suffixes we use for naming methods and interfaces.
 
 ## 7.0.0-preview.4 (2020-07-07)
 

sdk/servicebus/service-bus/review/service-bus.api.md

@@ -132,7 +132,7 @@ export interface PeekMessagesOptions extends OperationOptionsBase {
 }
 
 // @public
-export interface QueueDescription {
+export interface QueueProperties {
     authorizationRules?: AuthorizationRule[];
     autoDeleteOnIdle?: string;
     deadLetteringOnMessageExpiration?: boolean;
@@ -153,7 +153,7 @@ export interface QueueDescription {
 }
 
 // @public
-export interface QueueResponse extends QueueDescription, Response {
+export interface QueueResponse extends QueueProperties, Response {
 }
 
 // @public
@@ -228,14 +228,14 @@ export interface Response {
 export { RetryOptions }
 
 // @public
-export interface RuleDescription {
+export interface RuleProperties {
     action?: SqlRuleAction;
     filter?: SqlRuleFilter | CorrelationRuleFilter;
     name: string;
 }
 
 // @public
-export interface RuleResponse extends RuleDescription, Response {
+export interface RuleResponse extends RuleProperties, Response {
 }
 
 // @public
@@ -287,38 +287,38 @@ export class ServiceBusManagementClient extends ServiceClient {
     constructor(connectionString: string, options?: ServiceBusManagementClientOptions);
     constructor(fullyQualifiedNamespace: string, credential: TokenCredential, options?: ServiceBusManagementClientOptions);
     createQueue(queueName: string, operationOptions?: OperationOptions): Promise<QueueResponse>;
-    createQueue(queue: QueueDescription, operationOptions?: OperationOptions): Promise<QueueResponse>;
-    createRule(topicName: string, subscriptionName: string, rule: RuleDescription, operationOptions?: OperationOptions): Promise<RuleResponse>;
+    createQueue(queue: QueueProperties, operationOptions?: OperationOptions): Promise<QueueResponse>;
+    createRule(topicName: string, subscriptionName: string, rule: RuleProperties, operationOptions?: OperationOptions): Promise<RuleResponse>;
     createSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<SubscriptionResponse>;
-    createSubscription(subscription: SubscriptionDescription, operationOptions?: OperationOptions): Promise<SubscriptionResponse>;
+    createSubscription(subscription: SubscriptionProperties, operationOptions?: OperationOptions): Promise<SubscriptionResponse>;
     createTopic(topicName: string, operationOptions?: OperationOptions): Promise<TopicResponse>;
-    createTopic(topic: TopicDescription, operationOptions?: OperationOptions): Promise<TopicResponse>;
+    createTopic(topic: TopicProperties, operationOptions?: OperationOptions): Promise<TopicResponse>;
     deleteQueue(queueName: string, operationOptions?: OperationOptions): Promise<Response>;
     deleteRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<Response>;
     deleteSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<Response>;
     deleteTopic(topicName: string, operationOptions?: OperationOptions): Promise<Response>;
     getNamespaceProperties(operationOptions?: OperationOptions): Promise<NamespacePropertiesResponse>;
     getQueue(queueName: string, operationOptions?: OperationOptions): Promise<QueueResponse>;
     getQueueRuntimeProperties(queueName: string, operationOptions?: OperationOptions): Promise<QueueRuntimePropertiesResponse>;
-    getQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueDescription, EntitiesResponse<QueueDescription>>;
+    getQueues(options?: OperationOptions): PagedAsyncIterableIterator<QueueProperties, EntitiesResponse<QueueProperties>>;
     getQueuesRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<QueueRuntimeProperties, EntitiesResponse<QueueRuntimeProperties>>;
     getRule(topicName: string, subscriptionName: string, ruleName: string, operationOptions?: OperationOptions): Promise<RuleResponse>;
-    getRules(topicName: string, subscriptionName: string, options?: OperationOptions): PagedAsyncIterableIterator<RuleDescription, EntitiesResponse<RuleDescription>>;
+    getRules(topicName: string, subscriptionName: string, options?: OperationOptions): PagedAsyncIterableIterator<RuleProperties, EntitiesResponse<RuleProperties>>;
     getSubscription(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<SubscriptionResponse>;
     getSubscriptionRuntimeProperties(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<SubscriptionRuntimePropertiesResponse>;
-    getSubscriptions(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionDescription, EntitiesResponse<SubscriptionDescription>>;
+    getSubscriptions(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionProperties, EntitiesResponse<SubscriptionProperties>>;
     getSubscriptionsRuntimeProperties(topicName: string, options?: OperationOptions): PagedAsyncIterableIterator<SubscriptionRuntimeProperties, EntitiesResponse<SubscriptionRuntimeProperties>>;
     getTopic(topicName: string, operationOptions?: OperationOptions): Promise<TopicResponse>;
     getTopicRuntimeProperties(topicName: string, operationOptions?: OperationOptions): Promise<TopicRuntimePropertiesResponse>;
-    getTopics(options?: OperationOptions): PagedAsyncIterableIterator<TopicDescription, EntitiesResponse<TopicDescription>>;
+    getTopics(options?: OperationOptions): PagedAsyncIterableIterator<TopicProperties, EntitiesResponse<TopicProperties>>;
     getTopicsRuntimeProperties(options?: OperationOptions): PagedAsyncIterableIterator<TopicRuntimeProperties, EntitiesResponse<TopicRuntimeProperties>>;
     queueExists(queueName: string, operationOptions?: OperationOptions): Promise<boolean>;
     subscriptionExists(topicName: string, subscriptionName: string, operationOptions?: OperationOptions): Promise<boolean>;
     topicExists(topicName: string, operationOptions?: OperationOptions): Promise<boolean>;
-    updateQueue(queue: QueueDescription, operationOptions?: OperationOptions): Promise<QueueResponse>;
-    updateRule(topicName: string, subscriptionName: string, rule: RuleDescription, operationOptions?: OperationOptions): Promise<RuleResponse>;
-    updateSubscription(subscription: SubscriptionDescription, operationOptions?: OperationOptions): Promise<SubscriptionResponse>;
-    updateTopic(topic: TopicDescription, operationOptions?: OperationOptions): Promise<TopicResponse>;
+    updateQueue(queue: QueueProperties, operationOptions?: OperationOptions): Promise<QueueResponse>;
+    updateRule(topicName: string, subscriptionName: string, rule: RuleProperties, operationOptions?: OperationOptions): Promise<RuleResponse>;
+    updateSubscription(subscription: SubscriptionProperties, operationOptions?: OperationOptions): Promise<SubscriptionResponse>;
+    updateTopic(topic: TopicProperties, operationOptions?: OperationOptions): Promise<TopicResponse>;
 }
 
 // @public
@@ -400,7 +400,7 @@ export interface SubscribeOptions extends OperationOptionsBase, MessageHandlerOp
 }
 
 // @public
-export interface SubscriptionDescription {
+export interface SubscriptionProperties {
     autoDeleteOnIdle?: string;
     deadLetteringOnFilterEvaluationExceptions?: boolean;
     deadLetteringOnMessageExpiration?: boolean;
@@ -418,7 +418,7 @@ export interface SubscriptionDescription {
 }
 
 // @public
-export interface SubscriptionResponse extends SubscriptionDescription, Response {
+export interface SubscriptionResponse extends SubscriptionProperties, Response {
 }
 
 // @public
@@ -441,7 +441,7 @@ export { TokenCredential }
 export { TokenType }
 
 // @public
-export interface TopicDescription {
+export interface TopicProperties {
     authorizationRules?: AuthorizationRule[];
     autoDeleteOnIdle?: string;
     defaultMessageTtl?: string;
@@ -457,7 +457,7 @@ export interface TopicDescription {
 }
 
 // @public
-export interface TopicResponse extends TopicDescription, Response {
+export interface TopicResponse extends TopicProperties, Response {
 }
 
 // @public

sdk/servicebus/service-bus/src/index.ts

@@ -33,18 +33,18 @@ export { Receiver } from "./receivers/receiver";
 export { SessionReceiver } from "./receivers/sessionReceiver";
 export { Sender } from "./sender";
 export { NamespaceProperties } from "./serializers/namespaceResourceSerializer";
-export { QueueDescription, QueueRuntimeProperties } from "./serializers/queueResourceSerializer";
+export { QueueProperties, QueueRuntimeProperties } from "./serializers/queueResourceSerializer";
 export {
-  RuleDescription,
+  RuleProperties,
   SqlParameter,
   SqlRuleAction,
   SqlRuleFilter
 } from "./serializers/ruleResourceSerializer";
 export {
-  SubscriptionDescription,
+  SubscriptionProperties,
   SubscriptionRuntimeProperties
 } from "./serializers/subscriptionResourceSerializer";
-export { TopicDescription, TopicRuntimeProperties } from "./serializers/topicResourceSerializer";
+export { TopicProperties, TopicRuntimeProperties } from "./serializers/topicResourceSerializer";
 export {
   EntitiesResponse,
   ListRequestOptions,

sdk/servicebus/service-bus/src/serializers/queueResourceSerializer.ts

@@ -31,7 +31,7 @@ import {
  * converts values to string and ensures the right order as expected by the service
  * @param queue
  */
-export function buildQueueOptions(queue: QueueDescription): InternalQueueOptions {
+export function buildQueueOptions(queue: QueueProperties): InternalQueueOptions {
   return {
     LockDuration: queue.lockDuration,
     MaxSizeInMegabytes: getStringOrUndefined(queue.maxSizeInMegabytes),
@@ -59,7 +59,7 @@ export function buildQueueOptions(queue: QueueDescription): InternalQueueOptions
  * response from the service
  * @param rawQueue
  */
-export function buildQueue(rawQueue: any): QueueDescription {
+export function buildQueue(rawQueue: any): QueueProperties {
   return {
     name: getString(rawQueue[Constants.QUEUE_NAME], "queueName"),
 
@@ -128,7 +128,7 @@ export function buildQueueRuntimeProperties(rawQueue: any): QueueRuntimeProperti
 /**
  * Represents settable options on a queue
  */
-export interface QueueDescription {
+export interface QueueProperties {
   /**
    * Name of the queue
    */
@@ -226,7 +226,7 @@ export interface QueueDescription {
   forwardTo?: string;
 
   /**
-   * The user provided metadata information associated with the queue description.
+   * The user provided metadata information associated with the queue.
    * Used to specify textual content such as tags, labels, etc.
    * Value must not exceed 1024 bytes encoded in utf-8.
    */
@@ -354,7 +354,7 @@ export interface InternalQueueOptions {
   ForwardTo?: string;
 
   /**
-   * The user provided metadata information associated with the queue description.
+   * The user provided metadata information associated with the queue.
    * Used to specify textual content such as tags, labels, etc.
    * Value must not exceed 1024 bytes encoded in utf-8.
    */

sdk/servicebus/service-bus/src/serializers/ruleResourceSerializer.ts

@@ -24,7 +24,7 @@ import {
  * response from the service
  * @param rawRule
  */
-export function buildRule(rawRule: any): RuleDescription {
+export function buildRule(rawRule: any): RuleProperties {
   return {
     name: getString(rawRule["RuleName"], "ruleName"),
     filter: getTopicFilter(rawRule["Filter"]),
@@ -88,7 +88,7 @@ function getRuleActionOrUndefined(value: any): SqlRuleAction | undefined {
 /**
  * Represents all attributes of a rule entity
  */
-export interface RuleDescription {
+export interface RuleProperties {
   /**
    * Name of the rule
    */
@@ -146,7 +146,7 @@ export interface SqlRuleFilter {
  * RuleResourceSerializer for serializing / deserializing Rule entities
  */
 export class RuleResourceSerializer implements AtomXmlSerializer {
-  serialize(rule: RuleDescription): object {
+  serialize(rule: RuleProperties): object {
     const resource: { Name: any; Filter: any; Action: any } = {
       Filter: {},
       Action: {},

sdk/servicebus/service-bus/src/serializers/subscriptionResourceSerializer.ts

@@ -28,7 +28,7 @@ import {
  * @param subscription
  */
 export function buildSubscriptionOptions(
-  subscription: SubscriptionDescription
+  subscription: SubscriptionProperties
 ): InternalSubscriptionOptions {
   return {
     LockDuration: subscription.lockDuration,
@@ -57,7 +57,7 @@ export function buildSubscriptionOptions(
  * the response from the service
  * @param rawSubscription
  */
-export function buildSubscription(rawSubscription: any): SubscriptionDescription {
+export function buildSubscription(rawSubscription: any): SubscriptionProperties {
   return {
     subscriptionName: getString(rawSubscription[Constants.SUBSCRIPTION_NAME], "subscriptionName"),
     topicName: getString(rawSubscription[Constants.TOPIC_NAME], "topicName"),
@@ -103,7 +103,9 @@ export function buildSubscription(rawSubscription: any): SubscriptionDescription
  * the response from the service
  * @param rawSubscription
  */
-export function buildSubscriptionRuntimeProperties(rawSubscription: any): SubscriptionRuntimeProperties {
+export function buildSubscriptionRuntimeProperties(
+  rawSubscription: any
+): SubscriptionRuntimeProperties {
   return {
     subscriptionName: getString(rawSubscription[Constants.SUBSCRIPTION_NAME], "subscriptionName"),
     topicName: getString(rawSubscription[Constants.TOPIC_NAME], "topicName"),
@@ -118,7 +120,7 @@ export function buildSubscriptionRuntimeProperties(rawSubscription: any): Subscr
 /**
  * Represents settable options on a subscription
  */
-export interface SubscriptionDescription {
+export interface SubscriptionProperties {
   /**
    * Name of the subscription
    */
@@ -202,7 +204,7 @@ export interface SubscriptionDescription {
   forwardTo?: string;
 
   /**
-   * The user provided metadata information associated with the subscription description.
+   * The user provided metadata information associated with the subscription.
    * Used to specify textual content such as tags, labels, etc.
    * Value must not exceed 1024 bytes encoded in utf-8.
    */
@@ -305,7 +307,7 @@ export interface InternalSubscriptionOptions {
   ForwardTo?: string;
 
   /**
-   * The user provided metadata information associated with the subscription description.
+   * The user provided metadata information associated with the subscription.
    * Used to specify textual content such as tags, labels, etc.
    * Value must not exceed 1024 bytes encoded in utf-8.
    */

sdk/servicebus/service-bus/src/serializers/topicResourceSerializer.ts

@@ -29,7 +29,7 @@ import {
  * converts values to string and ensures the right order as expected by the service
  * @param topic
  */
-export function buildTopicOptions(topic: TopicDescription): InternalTopicOptions {
+export function buildTopicOptions(topic: TopicProperties): InternalTopicOptions {
   return {
     DefaultMessageTimeToLive: topic.defaultMessageTtl,
     MaxSizeInMegabytes: getStringOrUndefined(topic.maxSizeInMegabytes),
@@ -52,7 +52,7 @@ export function buildTopicOptions(topic: TopicDescription): InternalTopicOptions
  * response from the service
  * @param rawTopic
  */
-export function buildTopic(rawTopic: any): TopicDescription {
+export function buildTopic(rawTopic: any): TopicProperties {
   return {
     name: getString(rawTopic[Constants.TOPIC_NAME], "topicName"),
     maxSizeInMegabytes: getInteger(rawTopic[Constants.MAX_SIZE_IN_MEGABYTES], "maxSizeInMegabytes"),
@@ -107,7 +107,7 @@ export function buildTopicRuntimeProperties(rawTopic: any): TopicRuntimeProperti
 /**
  * Represents settable options on a topic
  */
-export interface TopicDescription {
+export interface TopicProperties {
   /**
    * Name of the topic
    */
@@ -168,7 +168,7 @@ export interface TopicDescription {
   status?: EntityStatus;
 
   /**
-   * The user provided metadata information associated with the topic description.
+   * The user provided metadata information associated with the topic.
    * Used to specify textual content such as tags, labels, etc.
    * Value must not exceed 1024 bytes encoded in utf-8.
    */
@@ -256,7 +256,7 @@ export interface InternalTopicOptions {
   Status?: string;
 
   /**
-   * The user provided metadata information associated with the topic description.
+   * The user provided metadata information associated with the topic.
    * Used to specify textual content such as tags, labels, etc.
    * Value must not exceed 1024 bytes encoded in utf-8.
    */