[MetricsAdvisor] Flatten DataFeedOptions in data feed (Azure#12263)

jeremymeng · web-flow · commit e918a3ea9fc3 · 2020-11-06T23:21:13.000Z
and remove the wrapping `options`. We were putting into it all the
rest of optional settings that don't fit into any of groupings but
it's not necessary.
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/CHANGELOG.md b/sdk/metricsadvisor/ai-metrics-advisor/CHANGELOG.md
@@ -46,6 +46,7 @@
   - `IngestionStatus.timestamp`
   - `latestSuccessTimestamp` and `latestActiveTimestamp` in the return type of `getDataFeedIngestionProgress()`.
 - [Breaking] property `createdTime` on `DataFeed` and `MetricFeedbackCommon` to `createdOn`.
+- [Breaking] Remove the wrapping data feed `options` property from `DataFeed` and `DataFeedPatch` and flatten its child properties.
 - Parameters of `Date` type now also accept strings. No validation is done for the strings. The SDK calls `new Date()` to convert them to `Date`.
 - Handle potential new data feed source types gracefully
 
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/README.md b/sdk/metricsadvisor/ai-metrics-advisor/README.md
@@ -197,18 +197,16 @@ async function createDataFeed(adminClient, sqlServerConnectionString, sqlServerQ
       ingestionRetryDelayInSeconds: -1,
       stopRetryAfterInSeconds: -1
     },
-    options: {
-      rollupSettings: {
-        rollupType: "AutoRollup",
-        rollupMethod: "Sum",
-        rollupIdentificationValue: "__CUSTOM_SUM__"
-      },
-      missingDataPointFillSettings: {
-        fillType: "SmartFilling"
-      },
-      accessMode: "Private",
-      adminEmails: ["xyz@example.com"]
-    }
+    rollupSettings: {
+      rollupType: "AutoRollup",
+      rollupMethod: "Sum",
+      rollupIdentificationValue: "__CUSTOM_SUM__"
+    },
+    missingDataPointFillSettings: {
+      fillType: "SmartFilling"
+    },
+    accessMode: "Private",
+    adminEmails: ["xyz@example.com"]
   };
   const result = await adminClient.createDataFeed(dataFeed);
 
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/review/ai-metrics-advisor.api.md b/sdk/metricsadvisor/ai-metrics-advisor/review/ai-metrics-advisor.api.md
@@ -194,19 +194,18 @@ export type ChangeThresholdConditionUnion = {
 export type CreateDataFeedOptions = DataFeedOptions & OperationOptions;
 
 // @public
-export interface DataFeed {
+export type DataFeed = {
+    id: string;
+    name: string;
     createdOn: Date;
+    status: DataFeedStatus;
+    isAdmin: boolean;
     creator: string;
+    source: DataFeedSource;
+    schema: DataFeedSchema;
     granularity: DataFeedGranularity;
-    id: string;
     ingestionSettings: DataFeedIngestionSettings;
-    isAdmin: boolean;
-    name: string;
-    options?: DataFeedOptions;
-    schema: DataFeedSchema;
-    source: DataFeedSource;
-    status: DataFeedStatus;
-}
+} & DataFeedOptions;
 
 // @public
 export type DataFeedAccessMode = "Private" | "Public";
@@ -274,17 +273,16 @@ export interface DataFeedOptions {
 }
 
 // @public
-export interface DataFeedPatch {
-    ingestionSettings?: DataFeedIngestionSettings;
+export type DataFeedPatch = {
     name?: string;
-    options?: DataFeedOptions & {
-        status?: DataFeedDetailStatus;
-    };
+    source: DataFeedSourcePatch;
     schema?: {
         timestampColumn?: string;
     };
-    source: DataFeedSourcePatch;
-}
+    ingestionSettings?: DataFeedIngestionSettings;
+} & DataFeedOptions & {
+    status?: DataFeedDetailStatus;
+};
 
 // @public
 export type DataFeedRollupMethod = "None" | "Sum" | "Max" | "Min" | "Avg" | "Count";
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/samples/javascript/dataFeed.js b/sdk/metricsadvisor/ai-metrics-advisor/samples/javascript/dataFeed.js
@@ -109,18 +109,16 @@ async function createDataFeed(client) {
       ingestionRetryDelayInSeconds: -1,
       stopRetryAfterInSeconds: -1
     },
-    options: {
-      rollupSettings: {
-        rollupType: "AutoRollup",
-        rollupMethod: "Sum",
-        rollupIdentificationValue: "__SUM__"
-      },
-      missingDataPointFillSettings: {
-        fillType: "CustomValue",
-        customFillValue: 567
-      },
-      accessMode: "Private"
-    }
+    rollupSettings: {
+      rollupType: "AutoRollup",
+      rollupMethod: "Sum",
+      rollupIdentificationValue: "__SUM__"
+    },
+    missingDataPointFillSettings: {
+      fillType: "CustomValue",
+      customFillValue: 567
+    },
+    accessMode: "Private"
   };
 
   const result = await client.createDataFeed(feed);
@@ -149,13 +147,11 @@ async function updateDataFeed(client, dataFeedId) {
       stopRetryAfterInSeconds: 667777,
       ingestionStartOffsetInSeconds: 4444
     },
-    options: {
-      description: "New datafeed description",
-      missingDataPointFillSettings: {
-        fillType: "SmartFilling"
-      },
-      status: "Paused"
-    }
+    description: "New datafeed description",
+    missingDataPointFillSettings: {
+      fillType: "SmartFilling"
+    },
+    status: "Paused"
   };
 
   try {
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/samples/javascript/quickstart.js b/sdk/metricsadvisor/ai-metrics-advisor/samples/javascript/quickstart.js
@@ -116,18 +116,16 @@ async function createDataFeed(adminClient, sqlServerConnectionString, sqlServerQ
       ingestionRetryDelayInSeconds: -1,
       stopRetryAfterInSeconds: -1
     },
-    options: {
-      rollupSettings: {
-        rollupType: "AutoRollup",
-        rollupMethod: "Sum",
-        rollupIdentificationValue: "__SUM__"
-      },
-      missingDataPointFillSettings: {
-        fillType: "SmartFilling"
-      },
-      accessMode: "Private",
-      adminEmails: ["xyz@microsoft.com"]
-    }
+    rollupSettings: {
+      rollupType: "AutoRollup",
+      rollupMethod: "Sum",
+      rollupIdentificationValue: "__SUM__"
+    },
+    missingDataPointFillSettings: {
+      fillType: "SmartFilling"
+    },
+    accessMode: "Private",
+    adminEmails: ["xyz@microsoft.com"]
   };
   const result = await adminClient.createDataFeed(dataFeed);
   return result;
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/samples/typescript/src/dataFeed.ts b/sdk/metricsadvisor/ai-metrics-advisor/samples/typescript/src/dataFeed.ts
@@ -115,18 +115,16 @@ async function createDataFeed(
       ingestionRetryDelayInSeconds: -1,
       stopRetryAfterInSeconds: -1
     },
-    options: {
-      rollupSettings: {
-        rollupType: "AutoRollup",
-        rollupMethod: "Sum",
-        rollupIdentificationValue: "__CUSTOM_SUM__"
-      },
-      missingDataPointFillSettings: {
-        fillType: "CustomValue",
-        customFillValue: 567
-      },
-      accessMode: "Private"
-    }
+    rollupSettings: {
+      rollupType: "AutoRollup",
+      rollupMethod: "Sum",
+      rollupIdentificationValue: "__CUSTOM_SUM__"
+    },
+    missingDataPointFillSettings: {
+      fillType: "CustomValue",
+      customFillValue: 567
+    },
+    accessMode: "Private"
   };
   const result = await client.createDataFeed(feed);
 
@@ -155,13 +153,11 @@ async function updateDataFeed(client: MetricsAdvisorAdministrationClient, dataFe
       stopRetryAfterInSeconds: 667777,
       ingestionStartOffsetInSeconds: 4444
     },
-    options: {
-      description: "New datafeed description",
-      missingDataPointFillSettings: {
-        fillType: "SmartFilling"
-      },
-      status: "Paused"
-    }
+    description: "New datafeed description",
+    missingDataPointFillSettings: {
+      fillType: "SmartFilling"
+    },
+    status: "Paused"
   };
 
   try {
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/samples/typescript/src/quickstart.ts b/sdk/metricsadvisor/ai-metrics-advisor/samples/typescript/src/quickstart.ts
@@ -128,18 +128,16 @@ async function createDataFeed(
       ingestionRetryDelayInSeconds: -1,
       stopRetryAfterInSeconds: -1
     },
-    options: {
-      rollupSettings: {
-        rollupType: "AutoRollup",
-        rollupMethod: "Sum",
-        rollupIdentificationValue: "__SUM__"
-      },
-      missingDataPointFillSettings: {
-        fillType: "SmartFilling"
-      },
-      accessMode: "Private",
-      adminEmails: ["xyz@microsoft.com"]
-    }
+    rollupSettings: {
+      rollupType: "AutoRollup",
+      rollupMethod: "Sum",
+      rollupIdentificationValue: "__SUM__"
+    },
+    missingDataPointFillSettings: {
+      fillType: "SmartFilling"
+    },
+    accessMode: "Private",
+    adminEmails: ["xyz@microsoft.com"]
   };
   const result = await adminClient.createDataFeed(dataFeed);
 
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorAdministrationClient.ts b/sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorAdministrationClient.ts
@@ -187,35 +187,46 @@ export class MetricsAdvisorAdministrationClient {
       "MetricsAdvisorAdministrationClient-createDataFeed",
       operationOptions
     );
-    const { name, granularity, source, schema, ingestionSettings, options } = feed;
+    const {
+      name,
+      granularity,
+      source,
+      schema,
+      ingestionSettings,
+      rollupSettings,
+      missingDataPointFillSettings,
+      accessMode,
+      adminEmails,
+      viewerEmails,
+      description
+    } = feed;
+
     if (source.dataSourceType === "Unknown") {
       throw new Error("Cannot create a data feed with the Unknown source type.");
     }
+
     const needRollup: NeedRollupEnum | undefined =
-      options?.rollupSettings?.rollupType === "AutoRollup"
+      rollupSettings?.rollupType === "AutoRollup"
         ? "NeedRollup"
-        : options?.rollupSettings?.rollupType === "AlreadyRollup"
+        : rollupSettings?.rollupType === "AlreadyRollup"
         ? "AlreadyRollup"
-        : options?.rollupSettings?.rollupType === "NoRollup"
+        : rollupSettings?.rollupType === "NoRollup"
         ? "NoRollup"
         : undefined;
     const rollUpColumns: string[] | undefined =
-      options?.rollupSettings?.rollupType === "AutoRollup"
-        ? options?.rollupSettings.autoRollupGroupByColumnNames
+      rollupSettings?.rollupType === "AutoRollup"
+        ? rollupSettings.autoRollupGroupByColumnNames
         : undefined;
     const allUpIdentification: string | undefined =
-      options?.rollupSettings?.rollupType === "AutoRollup" ||
-      options?.rollupSettings?.rollupType === "AlreadyRollup"
-        ? options?.rollupSettings.rollupIdentificationValue
+      rollupSettings?.rollupType === "AutoRollup" || rollupSettings?.rollupType === "AlreadyRollup"
+        ? rollupSettings.rollupIdentificationValue
         : undefined;
     const rollUpMethod: DataFeedRollupMethod | undefined =
-      options?.rollupSettings?.rollupType === "AutoRollup"
-        ? options?.rollupSettings.rollupMethod
-        : undefined;
-    const fillMissingPointType = options?.missingDataPointFillSettings?.fillType;
+      rollupSettings?.rollupType === "AutoRollup" ? rollupSettings.rollupMethod : undefined;
+    const fillMissingPointType = missingDataPointFillSettings?.fillType;
     const fillMissingPointValue =
-      options?.missingDataPointFillSettings?.fillType === "CustomValue"
-        ? options?.missingDataPointFillSettings.customFillValue
+      missingDataPointFillSettings?.fillType === "CustomValue"
+        ? missingDataPointFillSettings.customFillValue
         : undefined;
     try {
       const requestOptions = operationOptionsToRequestOptionsBase(finalOptions);
@@ -237,10 +248,10 @@ export class MetricsAdvisorAdministrationClient {
         rollUpMethod,
         fillMissingPointType,
         fillMissingPointValue,
-        viewMode: options?.accessMode,
-        admins: options?.adminEmails,
-        viewers: options?.viewerEmails,
-        dataFeedDescription: options?.description,
+        viewMode: accessMode,
+        admins: adminEmails,
+        viewers: viewerEmails,
+        dataFeedDescription: description,
         ...finalOptions
       };
       const result = await this.client.createDataFeed(body, requestOptions);
@@ -467,7 +478,7 @@ export class MetricsAdvisorAdministrationClient {
         dataSourceParameter: patch.source.dataSourceParameter,
         // name and description
         dataFeedName: patch.name,
-        dataFeedDescription: patch.options?.description,
+        dataFeedDescription: patch.description,
         // schema
         timestampColumn: patch.schema?.timestampColumn,
         // ingestion settings
@@ -477,19 +488,19 @@ export class MetricsAdvisorAdministrationClient {
         minRetryIntervalInSeconds: patch.ingestionSettings?.ingestionRetryDelayInSeconds,
         stopRetryAfterInSeconds: patch.ingestionSettings?.stopRetryAfterInSeconds,
         // rollup settings
-        ...toServiceRollupSettings(patch.options?.rollupSettings),
+        ...toServiceRollupSettings(patch.rollupSettings),
         // missing point filling settings
-        fillMissingPointType: patch.options?.missingDataPointFillSettings?.fillType,
+        fillMissingPointType: patch.missingDataPointFillSettings?.fillType,
         fillMissingPointValue:
-          patch.options?.missingDataPointFillSettings?.fillType === "CustomValue"
-            ? patch.options.missingDataPointFillSettings.customFillValue
+          patch.missingDataPointFillSettings?.fillType === "CustomValue"
+            ? patch.missingDataPointFillSettings.customFillValue
             : undefined,
         // other options
-        viewMode: patch.options?.accessMode,
-        admins: patch.options?.adminEmails,
-        viewers: patch.options?.viewerEmails,
-        status: patch.options?.status,
-        actionLinkTemplate: patch.options?.actionLinkTemplate
+        viewMode: patch.accessMode,
+        admins: patch.adminEmails,
+        viewers: patch.viewerEmails,
+        status: patch.status,
+        actionLinkTemplate: patch.actionLinkTemplate
       };
       await this.client.updateDataFeed(dataFeedId, patchBody, requestOptions);
       return this.getDataFeed(dataFeedId);
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/src/models.ts b/sdk/metricsadvisor/ai-metrics-advisor/src/models.ts
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/src/transforms.ts b/sdk/metricsadvisor/ai-metrics-advisor/src/transforms.ts
diff --git a/sdk/metricsadvisor/ai-metrics-advisor/test/datafeed.spec.ts b/sdk/metricsadvisor/ai-metrics-advisor/test/datafeed.spec.ts
