Implement SLM Execute Retention API #4258

Author: codebrain

src/CodeGeneration/ApiGenerator/Configuration/CodeConfiguration.cs

@@ -62,7 +62,6 @@ public static class CodeConfiguration
 			"enrich.get_policy.json",
 			"enrich.put_policy.json",
 			"enrich.stats.json",
-			"slm.execute_retention.json",
 			"transform.delete_transform.json",
 			"transform.get_transform.json",
 			"transform.get_transform_stats.json",

src/Elasticsearch.Net/Api/RequestParameters/RequestParameters.SnapshotLifecycleManagement.cs

@@ -38,6 +38,13 @@ public class ExecuteSnapshotLifecycleRequestParameters : RequestParameters<Execu
 		public override bool SupportsBody => false;
 	}
 
+	///<summary>Request options for ExecuteRetention <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</para></summary>
+	public class ExecuteRetentionRequestParameters : RequestParameters<ExecuteRetentionRequestParameters>
+	{
+		public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
+		public override bool SupportsBody => false;
+	}
+
 	///<summary>Request options for GetSnapshotLifecycle <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get.html</para></summary>
 	public class GetSnapshotLifecycleRequestParameters : RequestParameters<GetSnapshotLifecycleRequestParameters>
 	{
@@ -56,6 +63,7 @@ public class GetSnapshotLifecycleStatsRequestParameters : RequestParameters<GetS
 	public class GetSnapshotLifecycleManagementStatusRequestParameters : RequestParameters<GetSnapshotLifecycleManagementStatusRequestParameters>
 	{
 		public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
+		public override bool SupportsBody => false;
 	}
 
 	///<summary>Request options for PutSnapshotLifecycle <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put.html</para></summary>
@@ -69,11 +77,13 @@ public class PutSnapshotLifecycleRequestParameters : RequestParameters<PutSnapsh
 	public class StartSnapshotLifecycleManagementRequestParameters : RequestParameters<StartSnapshotLifecycleManagementRequestParameters>
 	{
 		public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
+		public override bool SupportsBody => false;
 	}
 
 	///<summary>Request options for Stop <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-stop.html</para></summary>
 	public class StopSnapshotLifecycleManagementRequestParameters : RequestParameters<StopSnapshotLifecycleManagementRequestParameters>
 	{
 		public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
+		public override bool SupportsBody => false;
 	}
 }

src/Elasticsearch.Net/ElasticLowLevelClient.SnapshotLifecycleManagement.cs

@@ -65,6 +65,15 @@ public TResponse ExecuteSnapshotLifecycle<TResponse>(string policyId, ExecuteSna
 		[MapsApi("slm.execute_lifecycle", "policy_id")]
 		public Task<TResponse> ExecuteSnapshotLifecycleAsync<TResponse>(string policyId, ExecuteSnapshotLifecycleRequestParameters requestParameters = null, CancellationToken ctx = default)
 			where TResponse : class, IElasticsearchResponse, new() => DoRequestAsync<TResponse>(POST, Url($"_slm/policy/{policyId:policyId}/_execute"), ctx, null, RequestParams(requestParameters));
+		///<summary>POST on /_slm/_execute_retention <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</para></summary>
+		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
+		public TResponse ExecuteRetention<TResponse>(ExecuteRetentionRequestParameters requestParameters = null)
+			where TResponse : class, IElasticsearchResponse, new() => DoRequest<TResponse>(POST, "_slm/_execute_retention", null, RequestParams(requestParameters));
+		///<summary>POST on /_slm/_execute_retention <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</para></summary>
+		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
+		[MapsApi("slm.execute_retention", "")]
+		public Task<TResponse> ExecuteRetentionAsync<TResponse>(ExecuteRetentionRequestParameters requestParameters = null, CancellationToken ctx = default)
+			where TResponse : class, IElasticsearchResponse, new() => DoRequestAsync<TResponse>(POST, "_slm/_execute_retention", ctx, null, RequestParams(requestParameters));
 		///<summary>GET on /_slm/policy/{policy_id} <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get.html</para></summary>
 		///<param name = "policyId">Comma-separated list of snapshot lifecycle policies to retrieve</param>
 		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>

src/Nest/Descriptors.SnapshotLifecycleManagement.cs

@@ -72,6 +72,14 @@ protected ExecuteSnapshotLifecycleDescriptor(): base()
 	// Request parameters
 	}
 
+	///<summary>Descriptor for ExecuteRetention <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</para></summary>
+	public partial class ExecuteRetentionDescriptor : RequestDescriptorBase<ExecuteRetentionDescriptor, ExecuteRetentionRequestParameters, IExecuteRetentionRequest>, IExecuteRetentionRequest
+	{
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotLifecycleManagementExecuteRetention;
+	// values part of the url path
+	// Request parameters
+	}
+
 	///<summary>Descriptor for GetSnapshotLifecycle <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get.html</para></summary>
 	public partial class GetSnapshotLifecycleDescriptor : RequestDescriptorBase<GetSnapshotLifecycleDescriptor, GetSnapshotLifecycleRequestParameters, IGetSnapshotLifecycleRequest>, IGetSnapshotLifecycleRequest
 	{

src/Nest/ElasticClient.SnapshotLifecycleManagement.cs

@@ -85,6 +85,30 @@ internal SnapshotLifecycleManagementNamespace(ElasticClient client): base(client
 		/// </summary>
 		public Task<ExecuteSnapshotLifecycleResponse> ExecuteSnapshotLifecycleAsync(IExecuteSnapshotLifecycleRequest request, CancellationToken ct = default) => DoRequestAsync<IExecuteSnapshotLifecycleRequest, ExecuteSnapshotLifecycleResponse>(request, request.RequestParameters, ct);
 		/// <summary>
+		/// <c>POST</c> request to the <c>slm.execute_retention</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</a>
+		/// </summary>
+		public ExecuteRetentionResponse ExecuteRetention(Func<ExecuteRetentionDescriptor, IExecuteRetentionRequest> selector = null) => ExecuteRetention(selector.InvokeOrDefault(new ExecuteRetentionDescriptor()));
+		/// <summary>
+		/// <c>POST</c> request to the <c>slm.execute_retention</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</a>
+		/// </summary>
+		public Task<ExecuteRetentionResponse> ExecuteRetentionAsync(Func<ExecuteRetentionDescriptor, IExecuteRetentionRequest> selector = null, CancellationToken ct = default) => ExecuteRetentionAsync(selector.InvokeOrDefault(new ExecuteRetentionDescriptor()), ct);
+		/// <summary>
+		/// <c>POST</c> request to the <c>slm.execute_retention</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</a>
+		/// </summary>
+		public ExecuteRetentionResponse ExecuteRetention(IExecuteRetentionRequest request) => DoRequest<IExecuteRetentionRequest, ExecuteRetentionResponse>(request, request.RequestParameters);
+		/// <summary>
+		/// <c>POST</c> request to the <c>slm.execute_retention</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</a>
+		/// </summary>
+		public Task<ExecuteRetentionResponse> ExecuteRetentionAsync(IExecuteRetentionRequest request, CancellationToken ct = default) => DoRequestAsync<IExecuteRetentionRequest, ExecuteRetentionResponse>(request, request.RequestParameters, ct);
+		/// <summary>
 		/// <c>GET</c> request to the <c>slm.get_lifecycle</c> API, read more about this API online:
 		/// <para></para>
 		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get.html</a>

src/Nest/Requests.SnapshotLifecycleManagement.cs

@@ -97,6 +97,20 @@ protected ExecuteSnapshotLifecycleRequest(): base()
 	// Request parameters
 	}
 
+	[InterfaceDataContract]
+	public partial interface IExecuteRetentionRequest : IRequest<ExecuteRetentionRequestParameters>
+	{
+	}
+
+	///<summary>Request for ExecuteRetention <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html</para></summary>
+	public partial class ExecuteRetentionRequest : PlainRequestBase<ExecuteRetentionRequestParameters>, IExecuteRetentionRequest
+	{
+		protected IExecuteRetentionRequest Self => this;
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotLifecycleManagementExecuteRetention;
+	// values part of the url path
+	// Request parameters
+	}
+
 	[InterfaceDataContract]
 	public partial interface IGetSnapshotLifecycleRequest : IRequest<GetSnapshotLifecycleRequestParameters>
 	{

src/Nest/XPack/Slm/ExecuteRetention/ExecuteRetentionRequest.cs

@@ -0,0 +1,9 @@
+namespace Nest
+{
+	[MapsApi("slm.execute_retention")]
+	public partial interface IExecuteRetentionRequest { }
+
+	public partial class ExecuteRetentionRequest { }
+
+	public partial class ExecuteRetentionDescriptor { }
+}

src/Nest/XPack/Slm/ExecuteRetention/ExecuteRetentionResponse.cs

@@ -0,0 +1,4 @@
+namespace Nest
+{
+	public class ExecuteRetentionResponse : AcknowledgedResponseBase { }
+}

src/Nest/_Generated/ApiUrlsLookup.generated.cs

@@ -234,6 +234,7 @@ internal static class ApiUrlsLookups
 		internal static ApiUrls SecurityPutUser = new ApiUrls(new[]{"_security/user/{username}"});
 		internal static ApiUrls SnapshotLifecycleManagementDeleteSnapshotLifecycle = new ApiUrls(new[]{"_slm/policy/{policy_id}"});
 		internal static ApiUrls SnapshotLifecycleManagementExecuteSnapshotLifecycle = new ApiUrls(new[]{"_slm/policy/{policy_id}/_execute"});
+		internal static ApiUrls SnapshotLifecycleManagementExecuteRetention = new ApiUrls(new[]{"_slm/_execute_retention"});
 		internal static ApiUrls SnapshotLifecycleManagementGetSnapshotLifecycle = new ApiUrls(new[]{"_slm/policy/{policy_id}", "_slm/policy"});
 		internal static ApiUrls SnapshotLifecycleManagementGetSnapshotLifecycleStats = new ApiUrls(new[]{"_slm/stats"});
 		internal static ApiUrls SnapshotLifecycleManagementGetStatus = new ApiUrls(new[]{"_slm/status"});

src/Tests/Tests/XPack/Slm/SlmApiTests.cs

@@ -17,6 +17,7 @@ public class SlmApiTests : CoordinatedIntegrationTestBase<XPackCluster>
 		private const string CreateRepositoryStep = nameof(CreateRepositoryStep);
 		private const string DeleteSnapshotLifecycleStep = nameof(DeleteSnapshotLifecycleStep);
 		private const string ExecuteSnapshotLifecycleStep = nameof(ExecuteSnapshotLifecycleStep);
+		private const string ExecuteRetentionLifecycleStep = nameof(ExecuteRetentionLifecycleStep);
 		private const string GetAllSnapshotLifecycleStep = nameof(GetAllSnapshotLifecycleStep);
 		private const string GetSnapshotLifecycleStep = nameof(GetSnapshotLifecycleStep);
 		private const string GetMissingSnapshotLifecycleStep = nameof(GetMissingSnapshotLifecycleStep);
@@ -140,6 +141,18 @@ public SlmApiTests(XPackCluster cluster, EndpointUsage usage) : base(new Coordin
 						(v, c, r) => c.SnapshotLifecycleManagement.ExecuteSnapshotLifecycleAsync(r)
 					)
 			},
+			{
+				ExecuteRetentionLifecycleStep, u =>
+					u.Calls<ExecuteRetentionDescriptor, ExecuteRetentionRequest, IExecuteRetentionRequest,
+						ExecuteRetentionResponse>(
+						v => new ExecuteRetentionRequest(),
+						(v, d) => d,
+						(v, c, f) => c.SnapshotLifecycleManagement.ExecuteRetention(f),
+						(v, c, f) => c.SnapshotLifecycleManagement.ExecuteRetentionAsync(f),
+						(v, c, r) => c.SnapshotLifecycleManagement.ExecuteRetention(r),
+						(v, c, r) => c.SnapshotLifecycleManagement.ExecuteRetentionAsync(r)
+					)
+			},
 			{
 				GetSnapshotLifecycleAfterExecuteStep, u =>
 					u.Calls<GetSnapshotLifecycleDescriptor, GetSnapshotLifecycleRequest, IGetSnapshotLifecycleRequest, GetSnapshotLifecycleResponse>(
@@ -256,6 +269,12 @@ [I] public async Task ExecuteSnapshotLifecycleResponse() => await Assert<Execute
 				r.SnapshotName.Should().NotBeNull();
 			});
 
+		[I] public async Task ExecuteRetentionSnapshotLifecycleResponse() => await Assert<ExecuteRetentionResponse>(ExecuteRetentionLifecycleStep,
+			(v, r) =>
+			{
+				r.IsValid.Should().BeTrue();
+			});
+
 		[I] public async Task GetSnapshotLifeCycleAfterExecuteResponse() => await Assert<GetSnapshotLifecycleResponse>(GetSnapshotLifecycleAfterExecuteStep, (v, r) =>
 		{
 			r.IsValid.Should().BeTrue();