[Search] Rename HighWaterMark to the more generic ChangeTrackingState (Azure#24732)

* Rename HighWaterMark to the more generic ChangeTrackingState

* Update Changelog

* Rename properties in `IndexerChangeTrackingState`

* Rename parameters in `ModelFactory` class

Author: Mohit-Chakraborty

sdk/search/Azure.Search.Documents/CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Features Added
 
 ### Breaking Changes
+- Renamed `IndexerStateHighWaterMark` to `IndexerChangeTrackingState`.
+- Renamed the property `HighWaterMark` to `ChangeTrackingState` in `IndexerState`.
 
 ### Bugs Fixed
 

sdk/search/Azure.Search.Documents/api/Azure.Search.Documents.netstandard2.0.cs

@@ -819,6 +819,14 @@ public ImageAnalysisSkill(System.Collections.Generic.IEnumerable<Azure.Search.Do
         public static bool operator !=(Azure.Search.Documents.Indexes.Models.ImageDetail left, Azure.Search.Documents.Indexes.Models.ImageDetail right) { throw null; }
         public override string ToString() { throw null; }
     }
+    public partial class IndexerChangeTrackingState
+    {
+        internal IndexerChangeTrackingState() { }
+        public string AllDocumentsFinalState { get { throw null; } }
+        public string AllDocumentsInitialState { get { throw null; } }
+        public string ResetDocumentsFinalState { get { throw null; } }
+        public string ResetDocumentsInitialState { get { throw null; } }
+    }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct IndexerExecutionEnvironment : System.IEquatable<Azure.Search.Documents.Indexes.Models.IndexerExecutionEnvironment>
     {
@@ -880,19 +888,11 @@ public enum IndexerExecutionStatus
     public partial class IndexerState
     {
         internal IndexerState() { }
-        public Azure.Search.Documents.Indexes.Models.IndexerStateHighWaterMark HighWaterMark { get { throw null; } }
+        public Azure.Search.Documents.Indexes.Models.IndexerChangeTrackingState ChangeTrackingState { get { throw null; } }
         public Azure.Search.Documents.Indexes.Models.IndexingMode? Mode { get { throw null; } }
         public System.Collections.Generic.IReadOnlyList<string> ResetDataSourceDocumentIds { get { throw null; } }
         public System.Collections.Generic.IReadOnlyList<string> ResetDocumentKeys { get { throw null; } }
     }
-    public partial class IndexerStateHighWaterMark
-    {
-        internal IndexerStateHighWaterMark() { }
-        public string AllDocumentsFinalHighWaterMark { get { throw null; } }
-        public string AllDocumentsInitialHighWaterMark { get { throw null; } }
-        public string ResetDocumentsFinalHighWaterMark { get { throw null; } }
-        public string ResetDocumentsInitialHighWaterMark { get { throw null; } }
-    }
     public enum IndexerStatus
     {
         Unknown = 0,
@@ -2820,11 +2820,11 @@ public static partial class SearchModelFactory
         public static Azure.Search.Documents.Indexes.Models.DataDeletionDetectionPolicy DataDeletionDetectionPolicy(string oDataType) { throw null; }
         public static Azure.Search.Documents.Models.FacetResult FacetResult(long? count, System.Collections.Generic.IReadOnlyDictionary<string, object> additionalProperties) { throw null; }
         public static Azure.Search.Documents.Models.IndexDocumentsResult IndexDocumentsResult(System.Collections.Generic.IEnumerable<Azure.Search.Documents.Models.IndexingResult> results) { throw null; }
+        public static Azure.Search.Documents.Indexes.Models.IndexerChangeTrackingState IndexerChangeTrackingState(string allDocumentsInitialState, string allDocumentsFinalState, string resetDocumentsInitialState, string resetDocumentsFinalState) { throw null; }
         public static Azure.Search.Documents.Indexes.Models.IndexerExecutionResult IndexerExecutionResult(Azure.Search.Documents.Indexes.Models.IndexerExecutionStatus status = Azure.Search.Documents.Indexes.Models.IndexerExecutionStatus.TransientFailure, Azure.Search.Documents.Indexes.Models.IndexerExecutionStatusDetail? statusDetail = default(Azure.Search.Documents.Indexes.Models.IndexerExecutionStatusDetail?), Azure.Search.Documents.Indexes.Models.IndexerState currentState = null, string errorMessage = null, System.DateTimeOffset? startTime = default(System.DateTimeOffset?), System.DateTimeOffset? endTime = default(System.DateTimeOffset?), System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.SearchIndexerError> errors = null, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.SearchIndexerWarning> warnings = null, int itemCount = 0, int failedItemCount = 0, string initialTrackingState = null, string finalTrackingState = null) { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public static Azure.Search.Documents.Indexes.Models.IndexerExecutionResult IndexerExecutionResult(Azure.Search.Documents.Indexes.Models.IndexerExecutionStatus status, string errorMessage, System.DateTimeOffset? startTime, System.DateTimeOffset? endTime, System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SearchIndexerError> errors, System.Collections.Generic.IReadOnlyList<Azure.Search.Documents.Indexes.Models.SearchIndexerWarning> warnings, int itemCount, int failedItemCount, string initialTrackingState, string finalTrackingState) { throw null; }
-        public static Azure.Search.Documents.Indexes.Models.IndexerState IndexerState(Azure.Search.Documents.Indexes.Models.IndexingMode? mode = default(Azure.Search.Documents.Indexes.Models.IndexingMode?), string allDocumentsInitialHighWaterMark = null, string allDocumentsFinalHighWaterMark = null, string resetDocumentsInitialHighWaterMark = null, string resetDocumentsFinalHighWaterMark = null, System.Collections.Generic.IEnumerable<string> resetDocumentKeys = null, System.Collections.Generic.IEnumerable<string> resetDataSourceDocumentIds = null) { throw null; }
-        public static Azure.Search.Documents.Indexes.Models.IndexerStateHighWaterMark IndexerStateHighWaterMark(string allDocumentsInitialHighWaterMark, string allDocumentsFinalHighWaterMark, string resetDocumentsInitialHighWaterMark, string resetDocumentsFinalHighWaterMark) { throw null; }
+        public static Azure.Search.Documents.Indexes.Models.IndexerState IndexerState(Azure.Search.Documents.Indexes.Models.IndexingMode? mode = default(Azure.Search.Documents.Indexes.Models.IndexingMode?), string allDocumentsInitialChangeTrackingState = null, string allDocumentsFinalChangeTrackingState = null, string resetDocumentsInitialChangeTrackingState = null, string resetDocumentsFinalChangeTrackingState = null, System.Collections.Generic.IEnumerable<string> resetDocumentKeys = null, System.Collections.Generic.IEnumerable<string> resetDataSourceDocumentIds = null) { throw null; }
         public static Azure.Search.Documents.Models.IndexingResult IndexingResult(string key, string errorMessage, bool succeeded, int status) { throw null; }
         public static Azure.Search.Documents.Indexes.Models.LexicalAnalyzer LexicalAnalyzer(string oDataType, string name) { throw null; }
         public static Azure.Search.Documents.Indexes.Models.LexicalTokenizer LexicalTokenizer(string oDataType, string name) { throw null; }

sdk/search/Azure.Search.Documents/src/Indexes/Models/IndexerChangeTrackingState.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Azure.Search.Documents.Indexes.Models
+{
+    /// <summary> Represents the change tracking state during an indexer's execution. </summary>
+    public class IndexerChangeTrackingState
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="IndexerChangeTrackingState"/> class.
+        /// </summary>
+        /// <param name="allDocumentsInitialState">Change tracking state used when indexing starts on all documents in the datasource.</param>
+        /// <param name="allDocumentsFinalState">Change tracking state value when indexing finishes on all documents in the datasource.</param>
+        /// <param name="resetDocumentsInitialState">Change tracking state used when indexing starts on select, reset documents in the datasource.</param>
+        /// <param name="resetDocumentsFinalState">Change tracking state value when indexing finishes on select, reset documents in the datasource.</param>
+        internal IndexerChangeTrackingState(string allDocumentsInitialState, string allDocumentsFinalState, string resetDocumentsInitialState, string resetDocumentsFinalState)
+        {
+            AllDocumentsInitialState = allDocumentsInitialState;
+            AllDocumentsFinalState = allDocumentsFinalState;
+            ResetDocumentsInitialState = resetDocumentsInitialState;
+            ResetDocumentsFinalState = resetDocumentsFinalState;
+        }
+
+        /// <summary> Change tracking state used when indexing starts on all documents in the datasource. </summary>
+        public string AllDocumentsInitialState { get; }
+
+        /// <summary> Change tracking state value when indexing finishes on all documents in the datasource. </summary>
+        public string AllDocumentsFinalState { get; }
+
+        /// <summary> Change tracking state used when indexing starts on select, reset documents in the datasource. </summary>
+        public string ResetDocumentsInitialState  { get; }
+
+        /// <summary> Change tracking state value when indexing finishes on select, reset documents in the datasource. </summary>
+        public string ResetDocumentsFinalState  { get; }
+    }
+}

sdk/search/Azure.Search.Documents/src/Indexes/Models/IndexerState.cs

@@ -11,41 +11,41 @@ namespace Azure.Search.Documents.Indexes.Models
     public partial class IndexerState
     {
         /// <summary> Change tracking state used when indexing starts on all documents in the datasource. </summary>
-        internal string AllDocsInitialChangeTrackingState => HighWaterMark.AllDocumentsInitialHighWaterMark;
+        internal string AllDocsInitialChangeTrackingState => ChangeTrackingState.AllDocumentsInitialState;
 
         /// <summary> Change tracking state value when indexing finishes on all documents in the datasource. </summary>
-        internal string AllDocsFinalChangeTrackingState => HighWaterMark.AllDocumentsFinalHighWaterMark;
+        internal string AllDocsFinalChangeTrackingState => ChangeTrackingState.AllDocumentsFinalState;
 
         /// <summary> Change tracking state used when indexing starts on select, reset documents in the datasource. </summary>
-        internal string ResetDocsInitialChangeTrackingState => HighWaterMark.ResetDocumentsInitialHighWaterMark;
+        internal string ResetDocsInitialChangeTrackingState => ChangeTrackingState.ResetDocumentsInitialState ;
 
         /// <summary> Change tracking state value when indexing finishes on select, reset documents in the datasource. </summary>
-        internal string ResetDocsFinalChangeTrackingState => HighWaterMark.ResetDocumentsFinalHighWaterMark;
+        internal string ResetDocsFinalChangeTrackingState => ChangeTrackingState.ResetDocumentsFinalState ;
 
         /// <summary>
         /// Change tracking state for an indexer's execution.
         /// </summary>
-        public IndexerStateHighWaterMark HighWaterMark { get; }
+        public IndexerChangeTrackingState ChangeTrackingState { get; }
 
         /// <summary> The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids. </summary>
         [CodeGenMember("ResetDatasourceDocumentIds")]
         public IReadOnlyList<string> ResetDataSourceDocumentIds { get; }
 
         /// <summary> Initializes a new instance of IndexerState. </summary>
         /// <param name="mode"> The mode the indexer is running in. </param>
-        /// <param name="allDocumentsInitialHighWaterMark"> Change tracking state used when indexing starts on all documents in the datasource. </param>
-        /// <param name="allDocumentsFinalHighWaterMark"> Change tracking state value when indexing finishes on all documents in the datasource. </param>
-        /// <param name="resetDocumentsInitialHighWaterMark"> Change tracking state used when indexing starts on select, reset documents in the datasource. </param>
-        /// <param name="resetDocumentsFinalHighWaterMark"> Change tracking state value when indexing finishes on select, reset documents in the datasource. </param>
+        /// <param name="allDocumentsInitialChangeTrackingState"> Change tracking state used when indexing starts on all documents in the datasource. </param>
+        /// <param name="allDocumentsFinalChangeTrackingState"> Change tracking state value when indexing finishes on all documents in the datasource. </param>
+        /// <param name="resetDocumentsInitialChangeTrackingState"> Change tracking state used when indexing starts on select, reset documents in the datasource. </param>
+        /// <param name="resetDocumentsFinalChangeTrackingState"> Change tracking state value when indexing finishes on select, reset documents in the datasource. </param>
         /// <param name="resetDocumentKeys"> The list of document keys that have been reset. The document key is the document&apos;s unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys. </param>
         /// <param name="resetDataSourceDocumentIds"> The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids. </param>
-        internal IndexerState(IndexingMode? mode, string allDocumentsInitialHighWaterMark, string allDocumentsFinalHighWaterMark, string resetDocumentsInitialHighWaterMark, string resetDocumentsFinalHighWaterMark, IReadOnlyList<string> resetDocumentKeys, IReadOnlyList<string> resetDataSourceDocumentIds)
+        internal IndexerState(IndexingMode? mode, string allDocumentsInitialChangeTrackingState, string allDocumentsFinalChangeTrackingState, string resetDocumentsInitialChangeTrackingState, string resetDocumentsFinalChangeTrackingState, IReadOnlyList<string> resetDocumentKeys, IReadOnlyList<string> resetDataSourceDocumentIds)
         {
             Mode = mode;
             ResetDocumentKeys = resetDocumentKeys;
             ResetDataSourceDocumentIds = resetDataSourceDocumentIds;
 
-            HighWaterMark = new IndexerStateHighWaterMark(allDocumentsInitialHighWaterMark, allDocumentsFinalHighWaterMark, resetDocumentsInitialHighWaterMark, resetDocumentsFinalHighWaterMark);
+            ChangeTrackingState = new IndexerChangeTrackingState(allDocumentsInitialChangeTrackingState, allDocumentsFinalChangeTrackingState, resetDocumentsInitialChangeTrackingState, resetDocumentsFinalChangeTrackingState);
         }
     }
 }