[Backport master] Add support for the migrate to data tiers API (#5825)

* Add support for the migrate to data tiers API (#5823)

* Add empty request and response

* Support migrate to data tiers API

* Fixup

Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>

Author: github-actions[bot]

src/Nest/Descriptors.IndexLifecycleManagement.cs

@@ -123,6 +123,18 @@ public partial class GetIlmStatusDescriptor : RequestDescriptorBase<GetIlmStatus
 	// Request parameters
 	}
 
+	///<summary>Descriptor for MigrateToDataTiers <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html</para></summary>
+	public partial class MigrateToDataTiersDescriptor : RequestDescriptorBase<MigrateToDataTiersDescriptor, MigrateToDataTiersRequestParameters, IMigrateToDataTiersRequest>, IMigrateToDataTiersRequest
+	{
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.IndexLifecycleManagementMigrateToDataTiers;
+		protected override HttpMethod HttpMethod => HttpMethod.POST;
+		protected override bool SupportsBody => true;
+		// values part of the url path
+		// Request parameters
+		///<summary>If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false</summary>
+		public MigrateToDataTiersDescriptor DryRun(bool? dryrun = true) => Qs("dry_run", dryrun);
+	}
+
 	///<summary>Descriptor for MoveToStep <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html</para></summary>
 	public partial class MoveToStepDescriptor : RequestDescriptorBase<MoveToStepDescriptor, MoveToStepRequestParameters, IMoveToStepRequest>, IMoveToStepRequest
 	{

src/Nest/ElasticClient.IndexLifecycleManagement.cs

@@ -136,6 +136,30 @@ internal IndexLifecycleManagementNamespace(ElasticClient client): base(client)
 		/// </summary>
 		public Task<GetIlmStatusResponse> GetStatusAsync(IGetIlmStatusRequest request, CancellationToken ct = default) => DoRequestAsync<IGetIlmStatusRequest, GetIlmStatusResponse>(request, request.RequestParameters, ct);
 		/// <summary>
+		/// <c>POST</c> request to the <c>ilm.migrate_to_data_tiers</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html</a>
+		/// </summary>
+		public MigrateToDataTiersResponse MigrateToDataTiers(Func<MigrateToDataTiersDescriptor, IMigrateToDataTiersRequest> selector = null) => MigrateToDataTiers(selector.InvokeOrDefault(new MigrateToDataTiersDescriptor()));
+		/// <summary>
+		/// <c>POST</c> request to the <c>ilm.migrate_to_data_tiers</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html</a>
+		/// </summary>
+		public Task<MigrateToDataTiersResponse> MigrateToDataTiersAsync(Func<MigrateToDataTiersDescriptor, IMigrateToDataTiersRequest> selector = null, CancellationToken ct = default) => MigrateToDataTiersAsync(selector.InvokeOrDefault(new MigrateToDataTiersDescriptor()), ct);
+		/// <summary>
+		/// <c>POST</c> request to the <c>ilm.migrate_to_data_tiers</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html</a>
+		/// </summary>
+		public MigrateToDataTiersResponse MigrateToDataTiers(IMigrateToDataTiersRequest request) => DoRequest<IMigrateToDataTiersRequest, MigrateToDataTiersResponse>(request, request.RequestParameters);
+		/// <summary>
+		/// <c>POST</c> request to the <c>ilm.migrate_to_data_tiers</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html</a>
+		/// </summary>
+		public Task<MigrateToDataTiersResponse> MigrateToDataTiersAsync(IMigrateToDataTiersRequest request, CancellationToken ct = default) => DoRequestAsync<IMigrateToDataTiersRequest, MigrateToDataTiersResponse>(request, request.RequestParameters, ct);
+		/// <summary>
 		/// <c>POST</c> request to the <c>ilm.move_to_step</c> API, read more about this API online:
 		/// <para></para>
 		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html</a>

src/Nest/Requests.IndexLifecycleManagement.cs

@@ -168,6 +168,31 @@ public partial class GetIlmStatusRequest : PlainRequestBase<GetIlmStatusRequestP
 	// Request parameters
 	}
 
+	[InterfaceDataContract]
+	public partial interface IMigrateToDataTiersRequest : IRequest<MigrateToDataTiersRequestParameters>
+	{
+	}
+
+	///<summary>Request for MigrateToDataTiers <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html</para></summary>
+	public partial class MigrateToDataTiersRequest : PlainRequestBase<MigrateToDataTiersRequestParameters>, IMigrateToDataTiersRequest
+	{
+		protected IMigrateToDataTiersRequest Self => this;
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.IndexLifecycleManagementMigrateToDataTiers;
+		protected override HttpMethod HttpMethod => HttpMethod.POST;
+		protected override bool SupportsBody => true;
+		// values part of the url path
+		// Request parameters
+		///<summary>
+		/// If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The
+		/// default is false
+		///</summary>
+		public bool? DryRun
+		{
+			get => Q<bool? >("dry_run");
+			set => Q("dry_run", value);
+		}
+	}
+
 	[InterfaceDataContract]
 	public partial interface IMoveToStepRequest : IRequest<MoveToStepRequestParameters>
 	{

src/Nest/XPack/Ilm/MigrateToDataTiers/MigrateToDataTiersRequest.cs

@@ -0,0 +1,50 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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;
+
+namespace Nest
+{
+	[MapsApi("ilm.migrate_to_data_tiers")]
+	[ReadAs(typeof(MigrateToDataTiersRequest))]
+	public partial interface IMigrateToDataTiersRequest
+	{
+		/// <summary>
+		/// The legacy index template name to delete. Defaults to none.
+		/// </summary>
+		[DataMember(Name = "legacy_template_to_delete")]
+		string LegacyTemplateToDelete { get; set; }
+
+		/// <summary>
+		/// The name of the custom node attribute used for the indices and ILM policies allocation filtering. Defaults to data.
+		/// </summary>
+		[DataMember(Name = "node_attribute")]
+		string NodeAttribute { get; set; }
+	}
+
+	/// <summary>
+	/// Specifies properties for a migrate to data tiers request.
+	/// </summary>
+	public partial class MigrateToDataTiersRequest
+	{
+		/// <inheritdoc />
+		public string LegacyTemplateToDelete { get; set; }
+
+		/// <inheritdoc />
+		public string NodeAttribute { get; set; }
+	}
+
+	public partial class MigrateToDataTiersDescriptor
+	{
+		string IMigrateToDataTiersRequest.LegacyTemplateToDelete { get; set; }
+		string IMigrateToDataTiersRequest.NodeAttribute { get; set; }
+
+		/// <inheritdoc cref="IMigrateToDataTiersRequest.LegacyTemplateToDelete" />
+		public MigrateToDataTiersDescriptor LegacyTemplateToDelete(string legacyTemplateToDelete) =>
+			Assign(legacyTemplateToDelete, (a, v) => a.LegacyTemplateToDelete = v);
+
+		/// <inheritdoc cref="IMigrateToDataTiersRequest.NodeAttribute" />
+		public MigrateToDataTiersDescriptor NodeAttribute(string nodeAttribute) => Assign(nodeAttribute, (a, v) => a.NodeAttribute = v);
+	}
+}

src/Nest/XPack/Ilm/MigrateToDataTiers/MigrateToDataTiersResponse.cs

@@ -0,0 +1,40 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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.Runtime.Serialization;
+
+namespace Nest
+{
+	/// <summary>
+	/// The response from a migrate to data tiers request.
+	/// </summary>
+	public class MigrateToDataTiersResponse : ResponseBase
+	{
+		/// <summary>
+		/// Whether the request was a dry run.
+		/// </summary>
+		[DataMember(Name = "dry_run")]
+		public bool DryRun { get; internal set; }
+
+		/// <summary>
+		/// The ILM policies that were updated.
+		/// </summary>
+		[DataMember(Name = "migrated_ilm_policies")]
+		public IEnumerable<string> MigratedIlmPolicies { get; internal set; }
+
+		/// <summary>
+		/// The indices that were migrated to tier preference routing.
+		/// </summary>
+		[DataMember(Name = "migrated_indices")]
+		public IEnumerable<string> MigratedIndices { get; internal set; }
+
+		/// <summary>
+		/// Shows the name of the legacy index template that was deleted. This will be missing if no legacy index template was
+		/// deleted.
+		/// </summary>
+		[DataMember(Name = "removed_legacy_template")]
+		public string RemovedLegacyTemplate { get; internal set; }
+	}
+}

src/Nest/_Generated/ApiUrlsLookup.generated.cs

@@ -107,6 +107,7 @@ internal static class ApiUrlsLookups
 		internal static ApiUrls IndexLifecycleManagementExplainLifecycle = new ApiUrls(new[]{"{index}/_ilm/explain"});
 		internal static ApiUrls IndexLifecycleManagementGetLifecycle = new ApiUrls(new[]{"_ilm/policy/{policy_id}", "_ilm/policy"});
 		internal static ApiUrls IndexLifecycleManagementGetStatus = new ApiUrls(new[]{"_ilm/status"});
+		internal static ApiUrls IndexLifecycleManagementMigrateToDataTiers = new ApiUrls(new[]{"_ilm/migrate_to_data_tiers"});
 		internal static ApiUrls IndexLifecycleManagementMoveToStep = new ApiUrls(new[]{"_ilm/move/{index}"});
 		internal static ApiUrls IndexLifecycleManagementPutLifecycle = new ApiUrls(new[]{"_ilm/policy/{policy_id}"});
 		internal static ApiUrls IndexLifecycleManagementRemovePolicy = new ApiUrls(new[]{"{index}/_ilm/remove"});

tests/Tests/XPack/Ilm/MigrateToDataTiers/MigrateToDataTiersApiTests.cs

@@ -0,0 +1,47 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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;
+using Elastic.Elasticsearch.Xunit.XunitPlumbing;
+using Elastic.Transport;
+using Nest;
+using Tests.Core.ManagedElasticsearch.Clusters;
+using Tests.Framework.EndpointTests;
+using Tests.Framework.EndpointTests.TestState;
+
+namespace Tests.XPack.Ilm.MigrateToDataTiers
+{
+	[SkipVersion("<7.14.0", "Migrate to data tiers added in 7.14.0")]
+	public class MigrateToDataTiersApiTests
+		: ApiTestBase<XPackCluster, MigrateToDataTiersResponse, IMigrateToDataTiersRequest, MigrateToDataTiersDescriptor, MigrateToDataTiersRequest>
+	{
+		public MigrateToDataTiersApiTests(XPackCluster cluster, EndpointUsage usage) : base(cluster, usage) { }
+
+		protected override object ExpectJson =>
+			new { legacy_template_to_delete = "template-name", node_attribute = "test-attribute" };
+
+		protected override Func<MigrateToDataTiersDescriptor, IMigrateToDataTiersRequest> Fluent => d => d
+			.DryRun()
+			.LegacyTemplateToDelete("template-name")
+			.NodeAttribute("test-attribute");
+
+		protected override HttpMethod HttpMethod => HttpMethod.POST;
+
+		protected override MigrateToDataTiersRequest Initializer => new()
+		{
+			DryRun = true, LegacyTemplateToDelete = "template-name", NodeAttribute = "test-attribute"
+		};
+
+		protected override string UrlPath => "/_ilm/migrate_to_data_tiers?dry_run=true";
+
+		protected override LazyResponses ClientUsage() => Calls(
+			(client, f) => client.IndexLifecycleManagement.MigrateToDataTiers(f),
+			(client, f) => client.IndexLifecycleManagement.MigrateToDataTiersAsync(f),
+			(client, r) => client.IndexLifecycleManagement.MigrateToDataTiers(r),
+			(client, r) => client.IndexLifecycleManagement.MigrateToDataTiersAsync(r)
+		);
+
+		protected override MigrateToDataTiersDescriptor NewDescriptor() => new();
+	}
+}

tests/Tests/XPack/Ilm/MigrateToDataTiers/MigrateToDataTiersUrlTests.cs

@@ -0,0 +1,21 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// 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.Threading.Tasks;
+using Elastic.Elasticsearch.Xunit.XunitPlumbing;
+using Tests.Framework.EndpointTests;
+using static Tests.Framework.EndpointTests.UrlTester;
+
+namespace Tests.XPack.Ilm.MigrateToDataTiers
+{
+	public class MigrateToDataTiersUrlRequests : UrlTestsBase
+	{
+		[U] public override async Task Urls() =>
+			await POST("/_ilm/migrate_to_data_tiers")
+				.Fluent(c => c.IndexLifecycleManagement.MigrateToDataTiers())
+				.Request(c => c.IndexLifecycleManagement.MigrateToDataTiers())
+				.FluentAsync(c => c.IndexLifecycleManagement.MigrateToDataTiersAsync())
+				.RequestAsync(c => c.IndexLifecycleManagement.MigrateToDataTiersAsync());
+	}
+}