Add settings to create follow index and create auto follow pattern APIs (#4947) (#4965)

Relates: elastic/elasticsearch#58103

Co-authored-by: Russ Cam <russ.cam@elastic.co>

Author: github-actions[bot]

src/Nest/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/CreateAutoFollowPatternRequest.cs

@@ -2,7 +2,8 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 
 namespace Nest
 {
@@ -22,6 +23,8 @@ public partial class CreateAutoFollowPatternRequest
 		public string RemoteCluster { get; set; }
 		/// <inheritdoc cref="IAutoFollowPattern.LeaderIndexPatterns"/>
 		public IEnumerable<string> LeaderIndexPatterns { get; set; }
+		/// <inheritdoc cref="IAutoFollowPattern.Settings"/>
+		public IIndexSettings Settings { get; set; }
 		/// <inheritdoc cref="IAutoFollowPattern.FollowIndexPattern"/>
 		public string FollowIndexPattern { get; set; }
 		/// <inheritdoc cref="IAutoFollowPattern.MaxReadRequestOperationCount"/>
@@ -52,6 +55,7 @@ public partial class CreateAutoFollowPatternDescriptor
 		string IAutoFollowPattern.RemoteCluster { get; set; }
 		IEnumerable<string> IAutoFollowPattern.LeaderIndexPatterns { get; set; }
 		string IAutoFollowPattern.FollowIndexPattern { get; set; }
+		IIndexSettings IAutoFollowPattern.Settings { get; set; }
 		int? IAutoFollowPattern.MaxReadRequestOperationCount { get; set; }
 		long? IAutoFollowPattern.MaxOutstandingReadRequests { get; set; }
 		string IAutoFollowPattern.MaxReadRequestSize { get; set; }
@@ -78,6 +82,10 @@ public CreateAutoFollowPatternDescriptor LeaderIndexPatterns(params string[] lea
 		public CreateAutoFollowPatternDescriptor FollowIndexPattern(string followIndexPattern) =>
 			Assign(followIndexPattern, (a, v) => a.FollowIndexPattern = v);
 
+		/// <inheritdoc cref="IAutoFollowPattern.Settings"/>
+		public CreateAutoFollowPatternDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector) =>
+			Assign(selector, (a, v) => a.Settings = v?.Invoke(new IndexSettingsDescriptor())?.Value);
+
 		/// <inheritdoc cref="IAutoFollowPattern.MaxReadRequestOperationCount"/>
 		public CreateAutoFollowPatternDescriptor MaxReadRequestOperationCount(int? maxReadRequestOperationCount) =>
 			Assign(maxReadRequestOperationCount, (a, v) => a.MaxReadRequestOperationCount = v);

src/Nest/XPack/CrossClusterReplication/AutoFollow/GetAutoFollowPattern/GetAutoFollowPatternResponse.cs

@@ -109,6 +109,15 @@ public interface IAutoFollowPattern
 		[DataMember(Name = "leader_index_patterns")]
 		IEnumerable<string> LeaderIndexPatterns { get; set; }
 
+		/// <summary>
+		/// Settings to override from the leader index.
+		/// Note that certain settings can not be overrode e.g. index.number_of_shards.
+		/// <para />
+		/// Valid in Elasticsearch 7.9.0+
+		/// </summary>
+		[DataMember(Name ="settings")]
+		IIndexSettings Settings { get; set; }
+
 		/// <summary>
 		/// the maximum number of outstanding reads requests from the remote cluster
 		/// </summary>
@@ -189,6 +198,9 @@ public class AutoFollowPattern : IAutoFollowPattern
 		/// <inheritdoc cref="IAutoFollowPattern.LeaderIndexPatterns" />
 		public IEnumerable<string> LeaderIndexPatterns { get; set; }
 
+		/// <inheritdoc cref="IAutoFollowPattern.Settings" />
+		public IIndexSettings Settings { get; set; }
+
 		/// <inheritdoc cref="IAutoFollowPattern.MaxOutstandingReadRequests" />
 		public long? MaxOutstandingReadRequests { get; set; }
 

src/Nest/XPack/CrossClusterReplication/Follow/CreateFollowIndex/CreateFollowIndexRequest.cs

@@ -2,7 +2,8 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
-using System.Runtime.Serialization;
+using System;
+using System.Runtime.Serialization;
 
 namespace Nest
 {
@@ -22,6 +23,15 @@ public partial interface ICreateFollowIndexRequest
 		[DataMember(Name = "leader_index")]
 		IndexName LeaderIndex { get; set; }
 
+		/// <summary>
+		/// Settings to override from the leader index.
+		/// Note that certain settings can not be overrode e.g. index.number_of_shards.
+		/// <para />
+		/// Valid in Elasticsearch 7.9.0+
+		/// </summary>
+		[DataMember(Name ="settings")]
+		IIndexSettings Settings { get; set; }
+
 		/// <summary>the maximum number of operations to pull per read from the remote cluster </summary>
 		[DataMember(Name = "max_read_request_operation_count")]
 		long? MaxReadRequestOperationCount { get; set; }
@@ -85,6 +95,9 @@ public partial class CreateFollowIndexRequest
 		/// <inheritdoc cref="ICreateFollowIndexRequest.LeaderIndex"/>
 		public IndexName LeaderIndex { get; set; }
 
+		/// <inheritdoc cref="ICreateFollowIndexRequest.Settings"/>
+		public IIndexSettings Settings { get; set; }
+
 		/// <inheritdoc cref="ICreateFollowIndexRequest.MaxReadRequestOperationCount"/>
 		public long? MaxReadRequestOperationCount { get; set; }
 
@@ -121,6 +134,7 @@ public partial class CreateFollowIndexDescriptor
 	{
 		string ICreateFollowIndexRequest.RemoteCluster { get; set; }
 		IndexName ICreateFollowIndexRequest.LeaderIndex { get; set; }
+		IIndexSettings ICreateFollowIndexRequest.Settings { get; set; }
 		long? ICreateFollowIndexRequest.MaxReadRequestOperationCount { get; set; }
 		long? ICreateFollowIndexRequest.MaxOutstandingReadRequests { get; set; }
 		string ICreateFollowIndexRequest.MaxRequestSize { get; set; }
@@ -138,6 +152,10 @@ public partial class CreateFollowIndexDescriptor
 		/// <inheritdoc cref="ICreateFollowIndexRequest.LeaderIndex"/>
 		public CreateFollowIndexDescriptor LeaderIndex(IndexName index) => Assign(index, (a, v) => a.LeaderIndex = v);
 
+		/// <inheritdoc cref="ICreateFollowIndexRequest.Settings"/>
+		public CreateFollowIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector) =>
+			Assign(selector, (a, v) => a.Settings = v?.Invoke(new IndexSettingsDescriptor())?.Value);
+
 		/// <inheritdoc cref="ICreateFollowIndexRequest.MaxReadRequestOperationCount"/>
 		public CreateFollowIndexDescriptor MaxReadRequestOperationCount(long? max) => Assign(max, (a, v) => a.MaxReadRequestOperationCount = v);
 

tests/Tests/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/CreateAutoFollowPatternApiTests.cs

@@ -3,7 +3,8 @@
 // See the LICENSE file in the project root for more information
 
 using System;
-using Elasticsearch.Net;
+ using System.Collections.Generic;
+ using Elasticsearch.Net;
 using Nest;
 using Tests.Core.ManagedElasticsearch.Clusters;
 using Tests.Framework.EndpointTests;
@@ -19,6 +20,10 @@ public CreateAutoFollowPatternApiTests(XPackCluster cluster, EndpointUsage usage
 		{
 			follow_index_pattern = "y",
 			leader_index_patterns = new [] { "z" },
+			settings = new Dictionary<string, object>
+			{
+				["index.queries.cache.enabled"] = false
+			},
 			max_outstanding_read_requests = 100,
 			max_outstanding_write_requests = 101,
 			max_read_request_operation_count = 102,
@@ -38,6 +43,13 @@ public CreateAutoFollowPatternApiTests(XPackCluster cluster, EndpointUsage usage
 			.RemoteCluster("x")
 			.FollowIndexPattern("y")
 			.LeaderIndexPatterns("z")
+			.Settings(s => s
+				.Queries(q => q
+					.Cache(qc => qc
+						.Enabled(false)
+					)
+				)
+			)
 			.MaxWriteBufferSize("1mb")
 			.MaxOutstandingReadRequests(100)
 			.MaxOutstandingWriteRequests( 101)
@@ -57,6 +69,16 @@ public CreateAutoFollowPatternApiTests(XPackCluster cluster, EndpointUsage usage
 			RemoteCluster = "x",
 			FollowIndexPattern = "y",
 			LeaderIndexPatterns = new []{"z"},
+			Settings = new IndexSettings
+			{
+				Queries = new QueriesSettings
+				{
+					Cache = new QueriesCacheSettings
+					{
+						Enabled = false
+					}
+				}
+			},
 			MaxWriteBufferSize = "1mb",
 			MaxOutstandingReadRequests = 100,
 			MaxOutstandingWriteRequests = 101,

tests/Tests/XPack/CrossClusterReplication/AutoFollow/CreateAutoFollowPattern/CreateAutoFollowPatternUrlTests.cs

@@ -6,6 +6,7 @@
 using Elastic.Elasticsearch.Xunit.XunitPlumbing;
 using Nest;
 using Tests.Framework.EndpointTests;
+using static Tests.Framework.EndpointTests.UrlTester;
 
 namespace Tests.XPack.CrossClusterReplication.AutoFollow.CreateAutoFollowPattern
 {
@@ -14,7 +15,7 @@ public class CreateAutoFollowPatternUrlTests : UrlTestsBase
 		[U] public override async Task Urls()
 		{
 			var name = "x";
-			await UrlTester.PUT($"/_ccr/auto_follow/{name}")
+			await PUT($"/_ccr/auto_follow/{name}")
 				.Fluent(c => c.CrossClusterReplication.CreateAutoFollowPattern(name, d => d))
 				.Request(c => c.CrossClusterReplication.CreateAutoFollowPattern(new CreateAutoFollowPatternRequest(name)))
 				.FluentAsync(c => c.CrossClusterReplication.CreateAutoFollowPatternAsync(name, d => d))

tests/Tests/XPack/CrossClusterReplication/Follow/CreateFollowIndex/CreateFollowIndexApiTests.cs

@@ -3,7 +3,8 @@
 // See the LICENSE file in the project root for more information
 
 using System;
-using Elasticsearch.Net;
+ using System.Collections.Generic;
+ using Elasticsearch.Net;
 using Nest;
 using Tests.Core.ManagedElasticsearch.Clusters;
 using Tests.Framework.EndpointTests;
@@ -18,6 +19,10 @@ public CreateFollowIndexApiTests(XPackCluster cluster, EndpointUsage usage) : ba
 		protected override object ExpectJson { get; } = new
 		{
 			leader_index = "leader",
+			settings = new Dictionary<string, object>
+			{
+				["index.queries.cache.enabled"] = false
+			},
 			max_outstanding_read_requests = 100,
 			max_outstanding_write_requests = 101,
 			max_read_request_operation_count = 102,
@@ -46,6 +51,13 @@ public CreateFollowIndexApiTests(XPackCluster cluster, EndpointUsage usage) : ba
 			.MaxRequestSize("4mb")
 			.ReadPollTimeout("2m")
 			.LeaderIndex("leader")
+			.Settings(s => s
+				.Queries(q => q
+					.Cache(qc => qc
+						.Enabled(false)
+					)
+				)
+			)
 		;
 
 		protected override HttpMethod HttpMethod => HttpMethod.PUT;
@@ -64,6 +76,16 @@ public CreateFollowIndexApiTests(XPackCluster cluster, EndpointUsage usage) : ba
 			MaxRequestSize = "4mb",
 			ReadPollTimeout = "2m",
 			LeaderIndex = "leader",
+			Settings = new IndexSettings
+			{
+				Queries = new QueriesSettings
+				{
+					Cache = new QueriesCacheSettings
+					{
+						Enabled = false
+					}
+				}
+			},
 		};
 
 		protected override bool SupportsDeserialization => false;

tests/Tests/XPack/CrossClusterReplication/Follow/CreateFollowIndex/CreateFollowIndexUrlTests.cs

@@ -6,6 +6,7 @@
 using Elastic.Elasticsearch.Xunit.XunitPlumbing;
 using Nest;
 using Tests.Framework.EndpointTests;
+using static Tests.Framework.EndpointTests.UrlTester;
 
 namespace Tests.XPack.CrossClusterReplication.Follow.CreateFollowIndex
 {
@@ -14,7 +15,7 @@ public class CreateFollowIndexUrlTests : UrlTestsBase
 		[U] public override async Task Urls()
 		{
 			var name = "x";
-			await UrlTester.PUT($"/{name}/_ccr/follow")
+			await PUT($"/{name}/_ccr/follow")
 				.Fluent(c => c.CrossClusterReplication.CreateFollowIndex(name, d => d))
 				.Request(c => c.CrossClusterReplication.CreateFollowIndex(new CreateFollowIndexRequest(name)))
 				.FluentAsync(c => c.CrossClusterReplication.CreateFollowIndexAsync(name, d => d))