add mode to keep_types token filter (#3429)

Author: Mpdreamz

src/Nest/Analysis/TokenFilters/KeepTypesTokenFilter.cs

@@ -1,42 +1,63 @@
 using System.Collections.Generic;
+using System.Runtime.Serialization;
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 
 namespace Nest
 {
+	[JsonConverter(typeof(StringEnumConverter))]
+	public enum KeepTypesMode
+	{
+		[EnumMember(Value="include")]
+		Include,
+		[EnumMember(Value = "exclude")]
+		Exclude
+	}
+
 	/// <summary>
 	/// A token filter of type keep that only keeps tokens with text contained in a predefined set of words.
 	/// </summary>
 	public interface IKeepTypesTokenFilter : ITokenFilter
 	{
-		/// <summary>
-		/// A list of types to keep.
-		/// </summary>
+		/// <summary> A list of types to keep. </summary>
 		[JsonProperty("types")]
 		IEnumerable<string> Types { get; set; }
+
+		/// <summary> Whether to include or exclude the types provided on <see cref="Types"/> </summary>
+		[JsonProperty("mode")]
+		KeepTypesMode? Mode { get; set; }
 	}
-	/// <inheritdoc/>
+	/// <inheritdoc cref="IKeepTypesTokenFilter"/>
 	public class KeepTypesTokenFilter : TokenFilterBase
 	{
 		public KeepTypesTokenFilter() : base("keep_types") { }
 
-		/// <inheritdoc/>
+		/// <inheritdoc cref="IKeepTypesTokenFilter.Types"/>
 		public IEnumerable<string> Types { get; set; }
 
+		/// <inheritdoc cref="IKeepTypesTokenFilter.Mode"/>
+		public KeepTypesMode? Mode { get; set; }
+
 	}
-	///<inheritdoc/>
-	public class KeepTypesTokenFilterDescriptor 
+	/// <inheritdoc cref="IKeepTypesTokenFilter"/>
+	public class KeepTypesTokenFilterDescriptor
 		: TokenFilterDescriptorBase<KeepTypesTokenFilterDescriptor, IKeepTypesTokenFilter>, IKeepTypesTokenFilter
 	{
 		protected override string Type => "keep_types";
 
 		IEnumerable<string> IKeepTypesTokenFilter.Types { get; set; }
+		KeepTypesMode? IKeepTypesTokenFilter.Mode { get; set; }
 
-		///<inheritdoc/>
+		/// <inheritdoc cref="IKeepTypesTokenFilter.Types"/>
 		public KeepTypesTokenFilterDescriptor Types(IEnumerable<string> types) => Assign(a => a.Types = types);
 
-		///<inheritdoc/>
+		/// <inheritdoc cref="IKeepTypesTokenFilter.Types"/>
 		public KeepTypesTokenFilterDescriptor Types(params string[] types) => Assign(a => a.Types = types);
 
+		/// <inheritdoc cref="IKeepTypesTokenFilter.Mode"/>
+		public KeepTypesTokenFilterDescriptor Mode(KeepTypesMode? mode) => Assign(a => a.Mode = mode);
+
+
 	}
 
-}
+}

src/Tests/Tests/Analysis/TokenFilters/TokenFilterTests.cs

@@ -182,20 +182,33 @@ public class KeepTypesTests : TokenFilterAssertionBase<KeepTypesTests>
 		{
 			public override string Name => "keeptypes";
 
-			public override ITokenFilter Initializer =>
-				new KeepTypesTokenFilter {Types = new[] {"<NUM>", "<SOMETHINGELSE>"}};
+			private readonly string[] _types = {"<NUM>", "<SOMETHINGELSE>"};
 
-			public override FuncTokenFilters Fluent => (n, tf) => tf
-				.KeepTypes(n, t => t
-					.Types("<NUM>", "<SOMETHINGELSE>")
-				);
+			public override ITokenFilter Initializer => new KeepTypesTokenFilter {Types = _types};
 
-			public override object Json => new
+			public override FuncTokenFilters Fluent => (n, tf) => tf.KeepTypes(n, t => t.Types(_types));
+
+			public override object Json => new { type = "keep_types", types = _types };
+		}
+
+		[SkipVersion("<6.4.0", "The mode option was introduced in https://github.com/elastic/elasticsearch/pull/32012")]
+		public class KeepTypesModeTests : TokenFilterAssertionBase<KeepTypesTests>
+		{
+			public override string Name => "keeptypes";
+			private readonly string[] _types = {"<NUM>", "<SOMETHINGELSE>"};
+
+			public override ITokenFilter Initializer => new KeepTypesTokenFilter
 			{
-				type = "keep_types",
-				types = new[] {"<NUM>", "<SOMETHINGELSE>"}
+				Mode = KeepTypesMode.Exclude,
+				Types = _types
 			};
 
+			public override FuncTokenFilters Fluent => (n, tf) => tf.KeepTypes(n, t => t
+				.Mode(KeepTypesMode.Exclude)
+				.Types(_types)
+			);
+
+			public override object Json => new { type = "keep_types", types = _types, mode = "exclude" };
 		}
 
 		public class IcuCollationTests : TokenFilterAssertionBase<IcuCollationTests>

src/Tests/Tests/Analysis/Tokenizers/TokenizerTests.cs

@@ -203,7 +203,7 @@ public class StandardTests : TokenizerAssertionBase<StandardTests>
 
 			public override object Json => new {type = "standard"};
 		}
-    
+
 		public class CharGroupTests : TokenizerAssertionBase<CharGroupTests>
 		{
 			private readonly string[] _chars = {"whitespace", "-", "\n"};

src/Tests/Tests/Mapping/Types/Core/Keyword/KeywordPropertyTests.cs

@@ -2,6 +2,7 @@
 using Elastic.Xunit.XunitPlumbing;
 using Nest;
 using Tests.Analysis;
+using Tests.Analysis.Tokenizers;
 using Tests.Core.ManagedElasticsearch.Clusters;
 using Tests.Domain;
 using Tests.Framework.Integration;