Add SequenceNumber and PrimaryTerm to Hits, Get and MulitGetHit (#3714)

* Add SequenceNumber and PrimaryTerm to Hits, Get and MulitGetHit

This commit adds the SequenceNumber and PrimaryTerm properties to the Hit<T>, MultiGetHit<T> and GetResponse.

* Update SeqNo and SeqNoPrimaryTerm

This commit updates

- SeqNo
- SeqNoPrimaryTerm
- IfSeqNo

to expand SeqNo out to SequenceNumber, in generated types and methods, ofr consistency

Closes #3708

Author: russcam

src/CodeGeneration/ApiGenerator/Overrides/GlobalOverrides.cs

@@ -38,6 +38,8 @@ public class GlobalOverrides : EndpointOverridesBase
 			{ "s", "sort_by_columns" },
 			{ "v", "verbose" },
 			{ "ts", "include_timestamp" },
+			{ "if_seq_no", "if_sequence_number" },
+			{ "seq_no_primary_term", "sequence_number_primary_term" },
 		};
 
 		public override IEnumerable<string> RenderPartial => new[]

src/Elasticsearch.Net/Domain/RequestParameters/RequestParameters.Generated.cs

@@ -645,7 +645,7 @@ public class DeleteRequestParameters : RequestParameters<DeleteRequestParameters
 		///<summary>Explicit operation timeout</summary>
 		public TimeSpan Timeout { get => Q<TimeSpan>("timeout"); set => Q("timeout", value); }
 		///<summary>only perform the delete operation if the last operation that has changed the document has the specified sequence number</summary>
-		public long? IfSeqNo { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
+		public long? IfSequenceNumber { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
 		///<summary>only perform the delete operation if the last operation that has changed the document has the specified primary term</summary>
 		public long? IfPrimaryTerm { get => Q<long?>("if_primary_term"); set => Q("if_primary_term", value); }
 		///<summary>Explicit version number for concurrency control</summary>
@@ -919,7 +919,7 @@ public class IndexRequestParameters : RequestParameters<IndexRequestParameters>
 		///<summary>Specific version type</summary>
 		public VersionType? VersionType { get => Q<VersionType?>("version_type"); set => Q("version_type", value); }
 		///<summary>only perform the index operation if the last operation that has changed the document has the specified sequence number</summary>
-		public long? IfSeqNo { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
+		public long? IfSequenceNumber { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
 		///<summary>only perform the index operation if the last operation that has changed the document has the specified primary term</summary>
 		public long? IfPrimaryTerm { get => Q<long?>("if_primary_term"); set => Q("if_primary_term", value); }
 		///<summary>The pipeline id to preprocess incoming documents with</summary>
@@ -1839,7 +1839,7 @@ public class SearchRequestParameters : RequestParameters<SearchRequestParameters
 		///<summary>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</summary>
 		public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
 		///<summary>Specify whether to return sequence number and primary term of the last modification of each hit</summary>
-		public bool? SeqNoPrimaryTerm { get => Q<bool?>("seq_no_primary_term"); set => Q("seq_no_primary_term", value); }
+		public bool? SequenceNumberPrimaryTerm { get => Q<bool?>("seq_no_primary_term"); set => Q("seq_no_primary_term", value); }
 		///<summary>Specify if request cache should be used for this request or not, defaults to index level setting</summary>
 		public bool? RequestCache { get => Q<bool?>("request_cache"); set => Q("request_cache", value); }
 		///<summary>
@@ -2097,7 +2097,7 @@ public class UpdateRequestParameters : RequestParameters<UpdateRequestParameters
 		///<summary>Explicit operation timeout</summary>
 		public TimeSpan Timeout { get => Q<TimeSpan>("timeout"); set => Q("timeout", value); }
 		///<summary>only perform the update operation if the last operation that has changed the document has the specified sequence number</summary>
-		public long? IfSeqNo { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
+		public long? IfSequenceNumber { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
 		///<summary>only perform the update operation if the last operation that has changed the document has the specified primary term</summary>
 		public long? IfPrimaryTerm { get => Q<long?>("if_primary_term"); set => Q("if_primary_term", value); }
 	}
@@ -2834,7 +2834,7 @@ public class PutWatchRequestParameters : RequestParameters<PutWatchRequestParame
 		///<summary>Explicit version number for concurrency control</summary>
 		public long? Version { get => Q<long?>("version"); set => Q("version", value); }
 		///<summary>only update the watch if the last operation that has changed the watch has the specified sequence number</summary>
-		public long? IfSeqNo { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
+		public long? IfSequenceNumber { get => Q<long?>("if_seq_no"); set => Q("if_seq_no", value); }
 		///<summary>only update the watch if the last operation that has changed the watch has the specified primary term</summary>
 		public long? IfPrimaryTerm { get => Q<long?>("if_primary_term"); set => Q("if_primary_term", value); }
 	}

src/Nest/Document/Multiple/Bulk/BulkOperation/BulkDelete.cs

@@ -11,7 +11,7 @@ public interface IBulkDeleteOperation<T> : IBulkOperation
 		T Document { get; set; }
 
 		[DataMember(Name = "if_seq_no")]
-		long? IfSeqNo { get; set; }
+		long? IfSequenceNumber { get; set; }
 
 		[DataMember(Name = "if_primary_term")]
 		long? IfPrimaryTerm { get; set; }
@@ -27,7 +27,7 @@ public class BulkDeleteOperation<T> : BulkOperationBase, IBulkDeleteOperation<T>
 
 		public T Document { get; set; }
 
-		public long? IfSeqNo { get; set; }
+		public long? IfSequenceNumber { get; set; }
 
 		public long? IfPrimaryTerm { get; set; }
 
@@ -48,7 +48,7 @@ public class BulkDeleteDescriptor<T> : BulkOperationDescriptorBase<BulkDeleteDes
 	{
 		protected override Type BulkOperationClrType => typeof(T);
 		protected override string BulkOperationType => "delete";
-		long? IBulkDeleteOperation<T>.IfSeqNo { get; set; }
+		long? IBulkDeleteOperation<T>.IfSequenceNumber { get; set; }
 		long? IBulkDeleteOperation<T>.IfPrimaryTerm { get; set; }
 
 		T IBulkDeleteOperation<T>.Document { get; set; }
@@ -64,7 +64,7 @@ public class BulkDeleteDescriptor<T> : BulkOperationDescriptorBase<BulkDeleteDes
 		/// </summary>
 		public BulkDeleteDescriptor<T> Document(T @object) => Assign(@object, (a, v) => a.Document = v);
 
-		public BulkDeleteDescriptor<T> IfSeqNo(long? seqNo) => Assign(seqNo, (a, v) => a.IfSeqNo = v);
+		public BulkDeleteDescriptor<T> IfSequenceNumber(long? sequenceNumber) => Assign(sequenceNumber, (a, v) => a.IfSequenceNumber = v);
 
 		public BulkDeleteDescriptor<T> IfPrimaryTerm(long? primaryTerm) => Assign(primaryTerm, (a, v) => a.IfPrimaryTerm = v);
 	}

src/Nest/Document/Multiple/Bulk/BulkOperation/BulkIndex.cs

@@ -17,7 +17,7 @@ public interface IBulkIndexOperation<T> : IBulkOperation
 		string Pipeline { get; set; }
 
 		[DataMember(Name = "if_seq_no")]
-		long? IfSeqNo { get; set; }
+		long? IfSequenceNumber { get; set; }
 
 		[DataMember(Name = "if_primary_term")]
 		long? IfPrimaryTerm { get; set; }
@@ -35,7 +35,7 @@ public class BulkIndexOperation<T> : BulkOperationBase, IBulkIndexOperation<T>
 
 		public string Pipeline { get; set; }
 
-		public long? IfSeqNo { get; set; }
+		public long? IfSequenceNumber { get; set; }
 
 		public long? IfPrimaryTerm { get; set; }
 
@@ -59,7 +59,7 @@ public class BulkIndexDescriptor<T> : BulkOperationDescriptorBase<BulkIndexDescr
 		T IBulkIndexOperation<T>.Document { get; set; }
 		string IBulkIndexOperation<T>.Percolate { get; set; }
 		string IBulkIndexOperation<T>.Pipeline { get; set; }
-		long? IBulkIndexOperation<T>.IfSeqNo { get; set; }
+		long? IBulkIndexOperation<T>.IfSequenceNumber { get; set; }
 		long? IBulkIndexOperation<T>.IfPrimaryTerm { get; set; }
 
 		protected override object GetBulkOperationBody() => Self.Document;
@@ -80,8 +80,8 @@ public class BulkIndexDescriptor<T> : BulkOperationDescriptorBase<BulkIndexDescr
 
 		public BulkIndexDescriptor<T> Percolate(string percolate) => Assign(percolate, (a, v) => a.Percolate = v);
 
-		public BulkIndexDescriptor<T> IfSeqNo(long? seqNo) => Assign(seqNo, (a, v) => a.IfSeqNo = v);
+		public BulkIndexDescriptor<T> IfSequenceNumber(long? seqNo) => Assign(seqNo, (a, v) => a.IfSequenceNumber = v);
 
-		public BulkIndexDescriptor<T> IfPrimaryTerm(long? primaryTerm) => Assign(primaryTerm, (a, v) => a.IfSeqNo = v);
+		public BulkIndexDescriptor<T> IfPrimaryTerm(long? primaryTerm) => Assign(primaryTerm, (a, v) => a.IfSequenceNumber = v);
 	}
 }

src/Nest/Document/Multiple/MultiGet/Response/MultiGetHit.cs

@@ -22,6 +22,10 @@ public interface IMultiGetHit<out TDocument> where TDocument : class
 		string Type { get; }
 
 		long Version { get; }
+
+		long? SequenceNumber { get; }
+
+		long? PrimaryTerm { get; }
 	}
 
 	[DataContract]
@@ -55,5 +59,11 @@ public class MultiGetHit<TDocument> : IMultiGetHit<TDocument>
 
 		[DataMember(Name = "_version")]
 		public long Version { get; internal set; }
+
+		[DataMember(Name = "_seq_no")]
+		public long? SequenceNumber { get; internal set; }
+
+		[DataMember(Name = "_primary_term")]
+		public long? PrimaryTerm { get; internal set; }
 	}
 }

src/Nest/Document/Single/Get/GetResponse.cs

@@ -1,13 +1,14 @@
-using System;
-using System.Runtime.Serialization;
+using System.Runtime.Serialization;
 using Elasticsearch.Net;
 
 namespace Nest
 {
+	// TODO: Looks like this can be removed?
 	public interface IGetResponse<out TDocument> : IResponse where TDocument : class
 	{
 		TDocument Source { get; }
 	}
+
 	public class GetResponse<TDocument> : ResponseBase, IGetResponse<TDocument> where TDocument : class
 	{
 		[DataMember(Name = "fields")]
@@ -22,9 +23,15 @@ public class GetResponse<TDocument> : ResponseBase, IGetResponse<TDocument> wher
 		[DataMember(Name = "_index")]
 		public string Index { get; internal set; }
 
+		[DataMember(Name = "_primary_term")]
+		public long? PrimaryTerm { get; internal set; }
+
 		[DataMember(Name = "_routing")]
 		public string Routing { get; internal set; }
 
+		[DataMember(Name = "_seq_no")]
+		public long? SequenceNumber { get; internal set; }
+
 		[DataMember(Name = "_source")]
 		[JsonFormatter(typeof(SourceFormatter<>))]
 		public TDocument Source { get; internal set; }

src/Nest/Search/Search/Hits/Hit.cs

@@ -11,11 +11,19 @@ public interface IHitMetadata<out TDocument> where TDocument : class
 	{
 		[DataMember(Name = "_id")]
 		string Id { get; }
+
 		[DataMember(Name = "_index")]
 		string Index { get; }
+
+		[DataMember(Name = "_primary_term")]
+		long? PrimaryTerm { get; }
+
 		[DataMember(Name = "_routing")]
 		string Routing { get; }
 
+		[DataMember(Name = "_seq_no")]
+		long? SequenceNumber { get; }
+
 		[DataMember(Name = "_source")]
 		[JsonFormatter(typeof(SourceFormatter<>))]
 		TDocument Source { get; }
@@ -25,7 +33,7 @@ public interface IHitMetadata<out TDocument> where TDocument : class
 		string Type { get; }
 
 		[DataMember(Name = "_version")]
-		long? Version { get; }
+		long Version { get; }
 	}
 
 	internal static class HitMetadataConversionExtensions
@@ -39,9 +47,7 @@ public static IHitMetadata<TTarget> Copy<TDocument, TTarget>(this IHitMetadata<T
 				Type = source.Type,
 				Index = source.Index,
 				Id = source.Id,
-#pragma warning disable 618
 				Routing = source.Routing,
-#pragma warning restore 618
 				Source = mapper(source.Source)
 			};
 		}
@@ -58,52 +64,38 @@ public interface IHit<out TDocument> : IHitMetadata<TDocument>
 		[DataMember(Name = "fields")]
 		FieldValues Fields { get; }
 
+		/// <summary> see <see cref="Highlights" /> for easier access into this data structure </summary>
+		[DataMember(Name = "highlight")]
+		[JsonFormatter(typeof(VerbatimDictionaryKeysBaseFormatter<Dictionary<string, List<string>>, string, List<string>>))]
+		Dictionary<string, List<string>> Highlight { get; }
+
+		// TODO investigate this mapping
+		/// <summary> This provides easier access into <see cref="Highlight" /> </summary>
+		[IgnoreDataMember]
+		HighlightFieldDictionary Highlights { get; }
+
 		[DataMember(Name = "inner_hits")]
 		[JsonFormatter(typeof(VerbatimInterfaceReadOnlyDictionaryKeysFormatter<string, InnerHitsResult>))]
 		IReadOnlyDictionary<string, InnerHitsResult> InnerHits { get; }
 
-		[DataMember(Name = "_nested")]
-		NestedIdentity Nested { get; }
-
 		[DataMember(Name = "matched_queries")]
 		IReadOnlyCollection<string> MatchedQueries { get; }
 
+		[DataMember(Name = "_nested")]
+		NestedIdentity Nested { get; }
+
 		[DataMember(Name = "_score")]
 		double? Score { get; }
 
 		[DataMember(Name = "sort")]
 		IReadOnlyCollection<object> Sorts { get; }
-
-		// TODO investigate this mapping
-		/// <summary> This provides easier access into <see cref="Highlight"/> </summary>
-		[IgnoreDataMember]
-		HighlightFieldDictionary Highlights { get; }
-
-		/// <summary> see <see cref="Highlights"/> for easier access into this data structure </summary>
-		[DataMember(Name = "highlight")]
-		[JsonFormatter(typeof(VerbatimDictionaryKeysBaseFormatter<Dictionary<string, List<string>>, string, List<string>>))]
-		Dictionary<string, List<string>> Highlight { get; }
 	}
 
 	public class Hit<TDocument> : IHit<TDocument>
 		where TDocument : class
 	{
 		public Explanation Explanation { get; internal set; }
 		public FieldValues Fields { get; internal set; }
-		public string Id { get; internal set; }
-		public string Index { get; internal set; }
-		public IReadOnlyDictionary<string, InnerHitsResult> InnerHits { get; internal set; } =
-			EmptyReadOnly<string, InnerHitsResult>.Dictionary;
-		public IReadOnlyCollection<string> MatchedQueries { get; internal set; }
-			= EmptyReadOnly<string>.Collection;
-		public NestedIdentity Nested { get; internal set; }
-		public string Routing { get; internal set; }
-		public double? Score { get; set; }
-		public IReadOnlyCollection<object> Sorts { get; internal set; }
-			= EmptyReadOnly<object>.Collection;
-		public TDocument Source { get; internal set; }
-		public string Type { get; internal set; }
-		public long? Version { get; internal set; }
 
 		public Dictionary<string, List<string>> Highlight { get; set; }
 
@@ -114,17 +106,33 @@ public HighlightFieldDictionary Highlights
 				if (Highlight == null)
 					return new HighlightFieldDictionary();
 
-				var highlights = Highlight.Select(kv => new HighlightHit
-					{
-						DocumentId = Id,
-						Field = kv.Key,
-						Highlights = kv.Value
-					})
+				var highlights = Highlight.Select(kv => new HighlightHit { DocumentId = Id, Field = kv.Key, Highlights = kv.Value })
 					.ToDictionary(k => k.Field, v => v);
 
 				return new HighlightFieldDictionary(highlights);
 			}
 		}
 
+		public string Id { get; internal set; }
+		public string Index { get; internal set; }
+
+		public IReadOnlyDictionary<string, InnerHitsResult> InnerHits { get; internal set; } =
+			EmptyReadOnly<string, InnerHitsResult>.Dictionary;
+
+		public IReadOnlyCollection<string> MatchedQueries { get; internal set; }
+			= EmptyReadOnly<string>.Collection;
+
+		public NestedIdentity Nested { get; internal set; }
+		public long? PrimaryTerm { get; internal set; }
+		public string Routing { get; internal set; }
+		public double? Score { get; set; }
+		public long? SequenceNumber { get; internal set; }
+
+		public IReadOnlyCollection<object> Sorts { get; internal set; }
+			= EmptyReadOnly<object>.Collection;
+
+		public TDocument Source { get; internal set; }
+		public string Type { get; internal set; }
+		public long Version { get; internal set; }
 	}
 }