Add OnlyIfUnchanged parameter to CreateUpdate & Delete operations (Az…

…ure#9056)
AzureSDKAutomation · May 22, 2020 · 1677605 · 1677605
1 parent cfcf14a
commit 1677605
Show file tree

Hide file tree

Showing 5 changed files with 188 additions and 73 deletions.
diff --git a/sdk/search/search-documents/review/search-documents.api.md b/sdk/search/search-documents/review/search-documents.api.md
@@ -162,21 +162,30 @@ export type CreateIndexerOptions = OperationOptions;
 export type CreateIndexOptions = OperationOptions;
 
 // @public
-export type CreateorUpdateDataSourceOptions = OperationOptions & ETagOperationOptions;
+export interface CreateorUpdateDataSourceOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
-export type CreateorUpdateIndexerOptions = OperationOptions & ETagOperationOptions;
+export interface CreateorUpdateIndexerOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
-export interface CreateOrUpdateIndexOptions extends OperationOptions, ETagOperationOptions {
+export interface CreateOrUpdateIndexOptions extends OperationOptions {
     allowIndexDowntime?: boolean;
+    onlyIfUnchanged?: boolean;
 }
 
 // @public
-export type CreateOrUpdateSkillsetOptions = OperationOptions & ETagOperationOptions;
+export interface CreateOrUpdateSkillsetOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
-export type CreateOrUpdateSynonymMapOptions = OperationOptions & ETagOperationOptions;
+export interface CreateOrUpdateSynonymMapOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
 export type CreateSkillsetOptions = OperationOptions;
@@ -232,22 +241,32 @@ export interface DefaultCognitiveServicesAccount {
 }
 
 // @public
-export type DeleteDataSourceOptions = OperationOptions & ETagOperationOptions;
+export interface DeleteDataSourceOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
 export type DeleteDocumentsOptions = IndexDocuments;
 
 // @public
-export type DeleteIndexerOptions = OperationOptions & ETagOperationOptions;
+export interface DeleteIndexerOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
-export type DeleteIndexOptions = OperationOptions & ETagOperationOptions;
+export interface DeleteIndexOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
-export type DeleteSkillsetOptions = OperationOptions & ETagOperationOptions;
+export interface DeleteSkillsetOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
-export type DeleteSynonymMapOptions = OperationOptions & ETagOperationOptions;
+export interface DeleteSynonymMapOptions extends OperationOptions {
+    onlyIfUnchanged?: boolean;
+}
 
 // @public
 export interface DictionaryDecompounderTokenFilter {
@@ -340,11 +359,6 @@ export interface EntityRecognitionSkill {
 // @public
 export type EntityRecognitionSkillLanguage = 'ar' | 'cs' | 'zh-Hans' | 'zh-Hant' | 'da' | 'nl' | 'en' | 'fi' | 'fr' | 'de' | 'el' | 'hu' | 'it' | 'ja' | 'ko' | 'no' | 'pl' | 'pt-PT' | 'pt-BR' | 'ru' | 'es' | 'sv' | 'tr';
 
-// @public
-export interface ETagOperationOptions {
-    accessCondition?: AccessCondition;
-}
-
 // @public
 export interface FacetResult {
     [property: string]: any;

diff --git a/sdk/search/search-documents/src/index.ts b/sdk/search/search-documents/src/index.ts
@@ -49,7 +49,6 @@ export {
   Skillset,
   ListSynonymMapsOptions,
   DeleteIndexOptions,
-  ETagOperationOptions,
   AnalyzeTextOptions,
   GetIndexOptions,
   GetIndexStatisticsOptions,

diff --git a/sdk/search/search-documents/src/searchIndexClient.ts b/sdk/search/search-documents/src/searchIndexClient.ts
@@ -340,10 +340,17 @@ export class SearchIndexClient {
   ): Promise<Index> {
     const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateIndex", options);
     try {
+      const etag = options.onlyIfUnchanged ? index.etag : undefined;
+
       const result = await this.client.indexes.createOrUpdate(
         index.name,
         utils.publicIndexToGeneratedIndex(index),
-        operationOptionsToRequestOptionsBase(updatedOptions)
+        {
+          ...operationOptionsToRequestOptionsBase(updatedOptions),
+          accessCondition: {
+            ifMatch: etag
+          }
+        }
       );
       return utils.generatedIndexToPublicIndex(result);
     } catch (e) {
@@ -371,10 +378,17 @@ export class SearchIndexClient {
       options
     );
     try {
+      const etag = options.onlyIfUnchanged ? synonymMap.etag : undefined;
+
       const result = await this.client.synonymMaps.createOrUpdate(
         synonymMap.name,
         utils.publicSynonymMapToGeneratedSynonymMap(synonymMap),
-        operationOptionsToRequestOptionsBase(updatedOptions)
+        {
+          ...operationOptionsToRequestOptionsBase(updatedOptions),
+          accessCondition: {
+            ifMatch: etag
+          }
+        }
       );
       return utils.generatedSynonymMapToPublicSynonymMap(result);
     } catch (e) {
@@ -397,11 +411,15 @@ export class SearchIndexClient {
     const { span, updatedOptions } = createSpan("SearchIndexClient-deleteIndex", options);
     try {
       const indexName: string = typeof index === "string" ? index : index.name;
+      const etag =
+        typeof index === "string" ? undefined : options.onlyIfUnchanged ? index.etag : undefined;
 
-      await this.client.indexes.deleteMethod(
-        indexName,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      await this.client.indexes.deleteMethod(indexName, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
     } catch (e) {
       span.setStatus({
         code: CanonicalCode.UNKNOWN,
@@ -425,11 +443,19 @@ export class SearchIndexClient {
     const { span, updatedOptions } = createSpan("SearchIndexClient-deleteSynonymMap", options);
     try {
       const synonymMapName: string = typeof synonymMap === "string" ? synonymMap : synonymMap.name;
+      const etag =
+        typeof synonymMap === "string"
+          ? undefined
+          : options.onlyIfUnchanged
+          ? synonymMap.etag
+          : undefined;
 
-      await this.client.synonymMaps.deleteMethod(
-        synonymMapName,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      await this.client.synonymMaps.deleteMethod(synonymMapName, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
     } catch (e) {
       span.setStatus({
         code: CanonicalCode.UNKNOWN,

diff --git a/sdk/search/search-documents/src/searchIndexerClient.ts b/sdk/search/search-documents/src/searchIndexerClient.ts
@@ -453,11 +453,14 @@ export class SearchIndexerClient {
       options
     );
     try {
-      const result = await this.client.indexers.createOrUpdate(
-        indexer.name,
-        indexer,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      const etag = options.onlyIfUnchanged ? indexer.etag : undefined;
+
+      const result = await this.client.indexers.createOrUpdate(indexer.name, indexer, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
       return result;
     } catch (e) {
       span.setStatus({
@@ -484,11 +487,14 @@ export class SearchIndexerClient {
       options
     );
     try {
-      const result = await this.client.dataSources.createOrUpdate(
-        dataSource.name,
-        dataSource,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      const etag = options.onlyIfUnchanged ? dataSource.etag : undefined;
+
+      const result = await this.client.dataSources.createOrUpdate(dataSource.name, dataSource, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
       return utils.generatedDataSourceToPublicDataSource(result);
     } catch (e) {
       span.setStatus({
@@ -515,11 +521,19 @@ export class SearchIndexerClient {
       options
     );
     try {
+      const etag = options.onlyIfUnchanged ? skillset.etag : undefined;
+
       const result = await this.client.skillsets.createOrUpdate(
         skillset.name,
         utils.publicSkillsetToGeneratedSkillset(skillset),
-        operationOptionsToRequestOptionsBase(updatedOptions)
+        {
+          ...operationOptionsToRequestOptionsBase(updatedOptions),
+          accessCondition: {
+            ifMatch: etag
+          }
+        }
       );
+
       return utils.generatedSkillsetToPublicSkillset(result);
     } catch (e) {
       span.setStatus({
@@ -544,11 +558,19 @@ export class SearchIndexerClient {
     const { span, updatedOptions } = createSpan("SearchIndexerClient-deleteIndexer", options);
     try {
       const indexerName: string = typeof indexer === "string" ? indexer : indexer.name;
-
-      await this.client.indexers.deleteMethod(
-        indexerName,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      const etag =
+        typeof indexer === "string"
+          ? undefined
+          : options.onlyIfUnchanged
+          ? indexer.etag
+          : undefined;
+
+      await this.client.indexers.deleteMethod(indexerName, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
     } catch (e) {
       span.setStatus({
         code: CanonicalCode.UNKNOWN,
@@ -572,11 +594,19 @@ export class SearchIndexerClient {
     const { span, updatedOptions } = createSpan("SearchIndexerClient-deleteDataSource", options);
     try {
       const dataSourceName: string = typeof dataSource === "string" ? dataSource : dataSource.name;
-
-      await this.client.dataSources.deleteMethod(
-        dataSourceName,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      const etag =
+        typeof dataSource === "string"
+          ? undefined
+          : options.onlyIfUnchanged
+          ? dataSource.etag
+          : undefined;
+
+      await this.client.dataSources.deleteMethod(dataSourceName, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
     } catch (e) {
       span.setStatus({
         code: CanonicalCode.UNKNOWN,
@@ -600,11 +630,19 @@ export class SearchIndexerClient {
     const { span, updatedOptions } = createSpan("SearchIndexerClient-deleteSkillset", options);
     try {
       const skillsetName: string = typeof skillset === "string" ? skillset : skillset.name;
-
-      await this.client.skillsets.deleteMethod(
-        skillsetName,
-        operationOptionsToRequestOptionsBase(updatedOptions)
-      );
+      const etag =
+        typeof skillset === "string"
+          ? undefined
+          : options.onlyIfUnchanged
+          ? skillset.etag
+          : undefined;
+
+      await this.client.skillsets.deleteMethod(skillsetName, {
+        ...operationOptionsToRequestOptionsBase(updatedOptions),
+        accessCondition: {
+          ifMatch: etag
+        }
+      });
     } catch (e) {
       span.setStatus({
         code: CanonicalCode.UNKNOWN,