Implement dangling indices APIs (#4870) (#4880)

This commit implements the dangling indices APIs
that can be used to list, import and delete
dangling indices.

Co-authored-by: Russ Cam <[email protected]>

src/ApiGenerator/Configuration/CodeConfiguration.cs

@@ -35,9 +35,6 @@ public static class CodeConfiguration
 
 		public static string[] IgnoredApisHighLevel { get; } =
 		{
-			"dangling_indices.list_dangling_indices.json", // TODO: implement
-			"dangling_indices.import_dangling_index.json", // TODO: implement
-			"dangling_indices.delete_dangling_index.json", // TODO: implement
 			"indices.add_block.json", // TODO: implement
 			"indices.resolve_index.json", // TODO: implement
 			"security.clear_cached_privileges.json", // TODO: implement

src/ApiGenerator/Domain/Specification/UrlPart.cs

@@ -104,6 +104,8 @@ public string HighLevelTypeName
 					case "type":
 						return Type == "string" ? "Name" : "Names";
 
+					case "index_uuid":
+						return "IndexUuid";
 
 					//This forces a compilation error post code generation as intended
 					default: return Type + "_";

src/Nest/CommonAbstractions/Infer/IndexUuid/IndexUuid.cs

@@ -0,0 +1,43 @@
+// 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 Elasticsearch.Net;
+
+namespace Nest
+{
+	public class IndexUuid : IUrlParameter, IEquatable<IndexUuid>
+	{
+		public string Value { get; }
+
+		public IndexUuid(string value) => Value = value ?? throw new ArgumentNullException(nameof(value));
+
+		public string GetString(IConnectionConfigurationValues settings) => Value;
+
+		public bool Equals(IndexUuid other)
+		{
+			if (ReferenceEquals(null, other)) return false;
+			if (ReferenceEquals(this, other)) return true;
+
+			return Value == other.Value;
+		}
+
+		public override bool Equals(object obj)
+		{
+			if (ReferenceEquals(null, obj)) return false;
+			if (ReferenceEquals(this, obj)) return true;
+			if (obj.GetType() != GetType()) return false;
+
+			return Equals((IndexUuid)obj);
+		}
+
+		public override int GetHashCode() => (Value != null ? Value.GetHashCode() : 0);
+
+		public static bool operator ==(IndexUuid left, IndexUuid right) => Equals(left, right);
+
+		public static bool operator !=(IndexUuid left, IndexUuid right) => !Equals(left, right);
+
+		public static implicit operator IndexUuid(string value) => string.IsNullOrEmpty(value) ? null : new IndexUuid(value);
+	}
+}

src/Nest/CommonAbstractions/Request/RouteValues.cs

@@ -50,14 +50,14 @@ private RouteValues Route(string name, IUrlParameter routeValue, bool required =
 		}
 
 		internal RouteValues Required(string route, IUrlParameter value) => Route(route, value);
-		
+
 		internal RouteValues Optional(string route, IUrlParameter value) => Route(route, value, false);
 
 		internal RouteValues Optional(string route, Metrics value) => Route(route, value, false);
 
 		internal RouteValues Optional(string route, IndexMetrics value) => Route(route, value, false);
 
-		internal TActual Get<TActual>(string route) 
+		internal TActual Get<TActual>(string route)
 		{
 			if (TryGetValue(route, out var actual) && actual != null)
 				return (TActual)actual;

src/Nest/DanglingIndices/Delete/DeleteDanglingIndexRequest.cs

@@ -0,0 +1,22 @@
+// 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
+
+namespace Nest
+{
+	[MapsApi("dangling_indices.delete_dangling_index.json")]
+	public partial interface IDeleteDanglingIndexRequest
+	{
+
+	}
+
+	public partial class DeleteDanglingIndexRequest : IDeleteDanglingIndexRequest
+	{
+
+	}
+
+	public partial class DeleteDanglingIndexDescriptor : IDeleteDanglingIndexRequest
+	{
+
+	}
+}

src/Nest/DanglingIndices/Delete/DeleteDanglingIndexResponse.cs

@@ -0,0 +1,14 @@
+// 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
+{
+	[DataContract]
+	public class DeleteDanglingIndexResponse : AcknowledgedResponseBase
+	{
+
+	}
+}

src/Nest/DanglingIndices/Import/ImportDanglingIndexRequest.cs

@@ -0,0 +1,22 @@
+// 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
+
+namespace Nest
+{
+	[MapsApi("dangling_indices.import_dangling_index.json")]
+	public partial interface IImportDanglingIndexRequest
+	{
+
+	}
+
+	public partial class ImportDanglingIndexRequest : IImportDanglingIndexRequest
+	{
+
+	}
+
+	public partial class ImportDanglingIndexDescriptor : IImportDanglingIndexRequest
+	{
+
+	}
+}

src/Nest/DanglingIndices/Import/ImportDanglingIndexResponse.cs

@@ -0,0 +1,13 @@
+// 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
+{
+	[DataContract]
+	public class ImportDanglingIndexResponse : AcknowledgedResponseBase
+	{
+	}
+}

src/Nest/DanglingIndices/List/ListDanglingIndicesRequest.cs

@@ -0,0 +1,22 @@
+// 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
+
+namespace Nest
+{
+	[MapsApi("dangling_indices.list_dangling_indices.json")]
+	public partial interface IListDanglingIndicesRequest
+	{
+
+	}
+
+	public partial class ListDanglingIndicesRequest : IListDanglingIndicesRequest
+	{
+
+	}
+
+	public partial class ListDanglingIndicesDescriptor : IListDanglingIndicesRequest
+	{
+
+	}
+}

src/Nest/DanglingIndices/List/ListDanglingIndicesResponse.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 System.Collections.Generic;
+using System.Runtime.Serialization;
+using Elasticsearch.Net;
+
+namespace Nest
+{
+	[DataContract]
+	public class ListDanglingIndicesResponse : ResponseBase
+	{
+		[DataMember(Name = "dangling_indices")]
+		public IReadOnlyCollection<AggregatedDanglingIndexInfo> DanglingIndices { get; internal set; } =
+			EmptyReadOnly<AggregatedDanglingIndexInfo>.Collection;
+	}
+
+	public class AggregatedDanglingIndexInfo
+	{
+		private DateTimeOffset? _creationDate;
+
+		[DataMember(Name = "index_name")]
+		public string IndexName { get; internal set; }
+
+		[DataMember(Name = "index_uuid")]
+		public string IndexUUID { get; internal set; }
+
+		[DataMember(Name = "creation_date_millis")]
+		public long CreationDateInMilliseconds { get; internal set; }
+
+		[DataMember(Name = "creation_date")]
+		public DateTimeOffset CreationDate
+		{
+			get
+			{
+				_creationDate ??= DateTimeOffset.FromUnixTimeMilliseconds(CreationDateInMilliseconds);
+				return _creationDate.Value;
+			}
+			internal set => _creationDate = value;
+		}
+
+		[DataMember(Name = "node_ids")]
+		public IReadOnlyCollection<string> NodeIds { get; internal set; }
+	}
+}

src/Nest/Descriptors.DanglingIndices.cs

@@ -0,0 +1,94 @@
+// ███╗   ██╗ ██████╗ ████████╗██╗ ██████╗███████╗
+// ████╗  ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝
+// ██╔██╗ ██║██║   ██║   ██║   ██║██║     █████╗  
+// ██║╚██╗██║██║   ██║   ██║   ██║██║     ██╔══╝  
+// ██║ ╚████║╚██████╔╝   ██║   ██║╚██████╗███████╗
+// ╚═╝  ╚═══╝ ╚═════╝    ╚═╝   ╚═╝ ╚═════╝╚══════╝
+// -----------------------------------------------
+//  
+// This file is automatically generated 
+// Please do not edit these files manually
+// Run the following in the root of the repos:
+//
+// 		*NIX 		:	./build.sh codegen
+// 		Windows 	:	build.bat codegen
+//
+// -----------------------------------------------
+// ReSharper disable RedundantUsingDirective
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Linq.Expressions;
+using Elasticsearch.Net;
+using Elasticsearch.Net.Utf8Json;
+using Elasticsearch.Net.Specification.DanglingIndicesApi;
+
+// ReSharper disable RedundantBaseConstructorCall
+// ReSharper disable UnusedTypeParameter
+// ReSharper disable PartialMethodWithSinglePart
+// ReSharper disable RedundantNameQualifier
+namespace Nest
+{
+	///<summary>Descriptor for DeleteDanglingIndex <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html</para></summary>
+	public partial class DeleteDanglingIndexDescriptor : RequestDescriptorBase<DeleteDanglingIndexDescriptor, DeleteDanglingIndexRequestParameters, IDeleteDanglingIndexRequest>, IDeleteDanglingIndexRequest
+	{
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.DanglingIndicesDeleteDanglingIndex;
+		///<summary>/_dangling/{index_uuid}</summary>
+		///<param name = "indexUuid">this parameter is required</param>
+		public DeleteDanglingIndexDescriptor(IndexUuid indexUuid): base(r => r.Required("index_uuid", indexUuid))
+		{
+		}
+
+		///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
+		[SerializationConstructor]
+		protected DeleteDanglingIndexDescriptor(): base()
+		{
+		}
+
+		// values part of the url path
+		IndexUuid IDeleteDanglingIndexRequest.IndexUuid => Self.RouteValues.Get<IndexUuid>("index_uuid");
+		// Request parameters
+		///<summary>Must be set to true in order to delete the dangling index</summary>
+		public DeleteDanglingIndexDescriptor AcceptDataLoss(bool? acceptdataloss = true) => Qs("accept_data_loss", acceptdataloss);
+		///<summary>Specify timeout for connection to master</summary>
+		public DeleteDanglingIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
+		///<summary>Explicit operation timeout</summary>
+		public DeleteDanglingIndexDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
+	}
+
+	///<summary>Descriptor for ImportDanglingIndex <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html</para></summary>
+	public partial class ImportDanglingIndexDescriptor : RequestDescriptorBase<ImportDanglingIndexDescriptor, ImportDanglingIndexRequestParameters, IImportDanglingIndexRequest>, IImportDanglingIndexRequest
+	{
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.DanglingIndicesImportDanglingIndex;
+		///<summary>/_dangling/{index_uuid}</summary>
+		///<param name = "indexUuid">this parameter is required</param>
+		public ImportDanglingIndexDescriptor(IndexUuid indexUuid): base(r => r.Required("index_uuid", indexUuid))
+		{
+		}
+
+		///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
+		[SerializationConstructor]
+		protected ImportDanglingIndexDescriptor(): base()
+		{
+		}
+
+		// values part of the url path
+		IndexUuid IImportDanglingIndexRequest.IndexUuid => Self.RouteValues.Get<IndexUuid>("index_uuid");
+		// Request parameters
+		///<summary>Must be set to true in order to import the dangling index</summary>
+		public ImportDanglingIndexDescriptor AcceptDataLoss(bool? acceptdataloss = true) => Qs("accept_data_loss", acceptdataloss);
+		///<summary>Specify timeout for connection to master</summary>
+		public ImportDanglingIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
+		///<summary>Explicit operation timeout</summary>
+		public ImportDanglingIndexDescriptor Timeout(Time timeout) => Qs("timeout", timeout);
+	}
+
+	///<summary>Descriptor for List <para>https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html</para></summary>
+	public partial class ListDanglingIndicesDescriptor : RequestDescriptorBase<ListDanglingIndicesDescriptor, ListDanglingIndicesRequestParameters, IListDanglingIndicesRequest>, IListDanglingIndicesRequest
+	{
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.DanglingIndicesList;
+	// values part of the url path
+	// Request parameters
+	}
+}