Implement ML Info Api (#3571)

Author: Stuart Cam

src/CodeGeneration/ApiGenerator/ApiGenerator.cs

@@ -26,7 +26,6 @@ public class ApiGenerator
 			//"rank_eval.json",
 
 			// these API's are new and need to be mapped
-			"xpack.ml.info.json",
 			"xpack.ml.delete_forecast.json",
 			"xpack.ml.find_file_structure.json",
 			"delete_by_query_rethrottle.json",

src/Elasticsearch.Net/Domain/RequestParameters/RequestParameters.Generated.cs

@@ -2452,6 +2452,11 @@ public class GetAnomalyRecordsRequestParameters : RequestParameters<GetAnomalyRe
 	{
 		public override HttpMethod DefaultHttpMethod => HttpMethod.POST;
 	}
+	///<summary>Request options for XpackMlInfo<pre></pre></summary>
+	public partial class MachineLearningInfoRequestParameters : RequestParameters<MachineLearningInfoRequestParameters> 
+	{
+		public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
+	}
 	///<summary>Request options for XpackMlOpenJob<pre>http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html</pre></summary>
 	public class OpenJobRequestParameters : RequestParameters<OpenJobRequestParameters>
 	{

src/Elasticsearch.Net/ElasticLowLevelClient.Generated.cs

@@ -3606,6 +3606,14 @@ public TResponse XpackMlGetRecords<TResponse>(string job_id, PostData body, GetA
 		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>
 		public Task<TResponse> XpackMlGetRecordsAsync<TResponse>(string job_id, PostData body, GetAnomalyRecordsRequestParameters requestParameters = null, CancellationToken ctx = default(CancellationToken))
 			where TResponse : class, IElasticsearchResponse, new() => this.DoRequestAsync<TResponse>(POST, Url($"_xpack/ml/anomaly_detectors/{job_id.NotNull("job_id")}/results/records"), ctx, body, _params(requestParameters));
+		///<summary>GET on /_xpack/ml/info <para></para></summary>
+		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>
+		public TResponse XpackMlInfo<TResponse>(MachineLearningInfoRequestParameters requestParameters = null)
+			where TResponse : class, IElasticsearchResponse, new() => this.DoRequest<TResponse>(GET, Url($"_xpack/ml/info"), null, _params(requestParameters));
+		///<summary>GET on /_xpack/ml/info <para></para></summary>
+		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>
+		public Task<TResponse> XpackMlInfoAsync<TResponse>(MachineLearningInfoRequestParameters requestParameters = null, CancellationToken ctx = default(CancellationToken))
+			where TResponse : class, IElasticsearchResponse, new() => this.DoRequestAsync<TResponse>(GET, Url($"_xpack/ml/info"), ctx, null, _params(requestParameters));
 		///<summary>POST on /_xpack/ml/anomaly_detectors/{job_id}/_open <para>http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html</para></summary>
 		///<param name="job_id">The ID of the job to open</param>
 		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>

src/Elasticsearch.Net/IElasticLowLevelClient.Generated.cs

@@ -2920,6 +2920,12 @@ public partial interface IElasticLowLevelClient
 		///<param name="body">Record selection criteria</param>
 		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>
 		Task<TResponse> XpackMlGetRecordsAsync<TResponse>(string job_id, PostData body, GetAnomalyRecordsRequestParameters requestParameters = null, CancellationToken ctx = default(CancellationToken)) where TResponse : class, IElasticsearchResponse, new();
+		///<summary>GET on /_xpack/ml/info <para></para></summary>
+		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>
+		TResponse XpackMlInfo<TResponse>(MachineLearningInfoRequestParameters requestParameters = null) where TResponse : class, IElasticsearchResponse, new();
+		///<summary>GET on /_xpack/ml/info <para></para></summary>
+		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>
+		Task<TResponse> XpackMlInfoAsync<TResponse>(MachineLearningInfoRequestParameters requestParameters = null, CancellationToken ctx = default(CancellationToken)) where TResponse : class, IElasticsearchResponse, new();
 		///<summary>POST on /_xpack/ml/anomaly_detectors/{job_id}/_open <para>http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html</para></summary>
 		///<param name="job_id">The ID of the job to open</param>
 		///<param name="requestParameters">A func that allows you to describe the querystring parameters &amp; request specific connection settings.</param>

src/Nest/XPack/MachineLearning/MachineLearningInfo/ElasticClient-MachineLearningInfo.cs

@@ -0,0 +1,58 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Elasticsearch.Net;
+
+namespace Nest
+{
+	public partial interface IElasticClient
+	{
+		/// <summary>
+		/// Retrieves machine learning job results for one or more categories.
+		/// </summary>
+		IMachineLearningInfoResponse MachineLearningInfo(Func<MachineLearningInfoDescriptor, IMachineLearningInfoRequest> selector = null);
+
+		/// <inheritdoc />
+		IMachineLearningInfoResponse MachineLearningInfo(IMachineLearningInfoRequest request);
+
+		/// <inheritdoc />
+		Task<IMachineLearningInfoResponse> MachineLearningInfoAsync(Func<MachineLearningInfoDescriptor, IMachineLearningInfoRequest> selector = null,
+			CancellationToken cancellationToken = default(CancellationToken)
+		);
+
+		/// <inheritdoc />
+		Task<IMachineLearningInfoResponse> MachineLearningInfoAsync(IMachineLearningInfoRequest request,
+			CancellationToken cancellationToken = default(CancellationToken)
+		);
+	}
+
+	public partial class ElasticClient
+	{
+		/// <inheritdoc />
+		public IMachineLearningInfoResponse MachineLearningInfo(Func<MachineLearningInfoDescriptor, IMachineLearningInfoRequest> selector = null) =>
+			MachineLearningInfo(selector.InvokeOrDefault(new MachineLearningInfoDescriptor()));
+
+		/// <inheritdoc />
+		public IMachineLearningInfoResponse MachineLearningInfo(IMachineLearningInfoRequest request) =>
+			Dispatcher.Dispatch<IMachineLearningInfoRequest, MachineLearningInfoRequestParameters, MachineLearningInfoResponse>(
+				request,
+				(p, d) => LowLevelDispatch.XpackMlInfoDispatch<MachineLearningInfoResponse>(p)
+			);
+
+		/// <inheritdoc />
+		public Task<IMachineLearningInfoResponse> MachineLearningInfoAsync(Func<MachineLearningInfoDescriptor, IMachineLearningInfoRequest> selector = null,
+			CancellationToken cancellationToken = default(CancellationToken)
+		) =>
+			MachineLearningInfoAsync(selector.InvokeOrDefault(new MachineLearningInfoDescriptor()), cancellationToken);
+
+		/// <inheritdoc />
+		public Task<IMachineLearningInfoResponse> MachineLearningInfoAsync(IMachineLearningInfoRequest request,
+			CancellationToken cancellationToken = default(CancellationToken)
+		) =>
+			Dispatcher.DispatchAsync<IMachineLearningInfoRequest, MachineLearningInfoRequestParameters, MachineLearningInfoResponse, IMachineLearningInfoResponse>(
+				request,
+				cancellationToken,
+				(p, d, c) => LowLevelDispatch.XpackMlInfoDispatchAsync<MachineLearningInfoResponse>(p, c)
+			);
+	}
+}

src/Nest/XPack/MachineLearning/MachineLearningInfo/MachineLearningInfoRequest.cs

@@ -0,0 +1,17 @@
+using System;
+using Newtonsoft.Json;
+
+namespace Nest
+{
+	/// <summary>
+	/// Retrieve job results for one or more categories.
+	/// </summary>
+	public partial interface IMachineLearningInfoRequest { }
+
+	/// <inheritdoc />
+	public partial class MachineLearningInfoRequest { }
+
+	/// <inheritdoc />
+	[DescriptorFor("XpackMlInfo")]
+	public partial class MachineLearningInfoDescriptor { }
+}

src/Nest/XPack/MachineLearning/MachineLearningInfo/MachineLearningInfoResponse.cs

@@ -0,0 +1,61 @@
+using Newtonsoft.Json;
+
+namespace Nest
+{
+	public interface IMachineLearningInfoResponse : IResponse
+	{
+		[JsonProperty("defaults")]
+		Defaults Defaults { get; }
+
+		[JsonProperty("limits")]
+		Limits Limits { get; }
+
+		[JsonProperty("upgrade_mode")]
+		bool? UpgradeMode { get; }
+	}
+
+	public class MachineLearningInfoResponse : ResponseBase, IMachineLearningInfoResponse
+	{
+		[JsonProperty("defaults")]
+		public Defaults Defaults { get; internal set; }
+
+		[JsonProperty("limits")]
+		public Limits Limits { get; internal set; }
+
+		[JsonProperty("upgrade_mode")]
+		public bool? UpgradeMode { get; internal set; }
+	}
+
+	public class Defaults
+	{
+		[JsonProperty("anomaly_detectors")]
+		public AnomalyDetectors AnomalyDetectors { get; internal set; }
+
+		[JsonProperty("datafeeds")]
+		public Datafeeds Datafeeds { get; internal set; }
+	}
+
+	public class AnomalyDetectors
+	{
+		[JsonProperty("model_memory_limit")]
+		public string ModelMemoryLimit { get; internal set; }
+
+		[JsonProperty("categorization_examples_limit")]
+		public int CategorizationExamplesLimit { get; internal set; }
+
+		[JsonProperty("model_snapshot_retention_days")]
+		public int ModelSnapshotRetentionDays { get; internal set; }
+	}
+
+	public class Datafeeds
+	{
+		[JsonProperty("scroll_size")]
+		public int ScrollSize { get; internal set; }
+	}
+
+	public class Limits
+	{
+		[JsonProperty("max_model_memory_limit")]
+		public string MaxModelMemoryLimit { get; internal set; }
+	}
+}

src/Nest/_Generated/_Descriptors.generated.cs

@@ -4435,6 +4435,14 @@ public GetAnomalyRecordsDescriptor(Id job_id) : base(r=>r.Required("job_id", job
 
 		// Request parameters
 
+	}
+	///<summary>descriptor for XpackMlInfo <pre></pre></summary>
+	public partial class MachineLearningInfoDescriptor  : RequestDescriptorBase<MachineLearningInfoDescriptor,MachineLearningInfoRequestParameters, IMachineLearningInfoRequest>, IMachineLearningInfoRequest
+	{ 
+		// values part of the url path
+
+		// Request parameters
+
 	}
 	///<summary>descriptor for XpackMlOpenJob <pre>http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html</pre></summary>
 	public partial class OpenJobDescriptor  : RequestDescriptorBase<OpenJobDescriptor,OpenJobRequestParameters, IOpenJobRequest>, IOpenJobRequest

src/Nest/_Generated/_LowLevelDispatch.generated.cs

@@ -3892,6 +3892,26 @@ internal partial class LowLevelDispatch
 			throw InvalidDispatch("XpackMlGetRecords", p, new [] { GET, POST }, "/_xpack/ml/anomaly_detectors/{job_id}/results/records");
 		}
 
+		internal TResponse XpackMlInfoDispatch<TResponse>(IRequest<MachineLearningInfoRequestParameters> p) where TResponse : class, IElasticsearchResponse, new()
+		{
+			switch(p.HttpMethod)
+			{
+				case GET:
+						return _lowLevel.XpackMlInfo<TResponse>(p.RequestParameters);
+			}
+			throw InvalidDispatch("XpackMlInfo", p, new [] { GET }, "/_xpack/ml/info");
+		}
+		
+		internal Task<TResponse> XpackMlInfoDispatchAsync<TResponse>(IRequest<MachineLearningInfoRequestParameters> p, CancellationToken ct) where TResponse : class, IElasticsearchResponse, new()
+		{
+			switch(p.HttpMethod)
+			{
+				case GET:
+						return _lowLevel.XpackMlInfoAsync<TResponse>(p.RequestParameters,ct);
+			}
+			throw InvalidDispatch("XpackMlInfo", p, new [] { GET }, "/_xpack/ml/info");
+		}
+		
 		internal TResponse XpackMlOpenJobDispatch<TResponse>(IRequest<OpenJobRequestParameters> p) where TResponse : class, IElasticsearchResponse, new()
 		{
 			switch(p.HttpMethod)

src/Nest/_Generated/_Requests.generated.cs

@@ -3873,6 +3873,18 @@ public partial class ListTasksRequest : PlainRequestBase<ListTasksRequestParamet
 		public string ParentNode { get => Q<string>("parent_node"); set => Q("parent_node", value); }
 	}
 	[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
+	public partial interface IMachineLearningInfoRequest : IRequest<MachineLearningInfoRequestParameters>
+	{
+	}
+	///<summary>Request parameters for XpackMlInfo <pre></pre></summary>
+	public partial class MachineLearningInfoRequest : PlainRequestBase<MachineLearningInfoRequestParameters>, IMachineLearningInfoRequest
+	{
+		protected IMachineLearningInfoRequest Self => this;
+		// values part of the url path
+
+		// Request parameters
+	}
+	[JsonObject(MemberSerialization = MemberSerialization.OptIn)]
 	public partial interface IMigrationAssistanceRequest : IRequest<MigrationAssistanceRequestParameters>
 	{
 		Indices Index { get; }

src/Tests/Tests/XPack/MachineLearning/MachineLearningInfo/MachineLearningInfoApiTests.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Linq;
+using Elasticsearch.Net;
+using FluentAssertions;
+using Nest;
+using Tests.Core.Extensions;
+using Tests.Framework;
+using Tests.Framework.Integration;
+using Tests.Framework.ManagedElasticsearch.Clusters;
+
+namespace Tests.XPack.MachineLearning.Info
+{
+	public class MachineLearningInfoApiTests
+		: MachineLearningIntegrationTestBase<IMachineLearningInfoResponse, IMachineLearningInfoRequest, MachineLearningInfoDescriptor, MachineLearningInfoRequest>
+	{
+		public MachineLearningInfoApiTests(MachineLearningCluster cluster, EndpointUsage usage) : base(cluster, usage) { }
+
+		protected override bool ExpectIsValid => true;
+		protected override object ExpectJson => null;
+		protected override int ExpectStatusCode => 200;
+		protected override Func<MachineLearningInfoDescriptor, IMachineLearningInfoRequest> Fluent => f => f;
+		protected override HttpMethod HttpMethod => HttpMethod.GET;
+
+		protected override MachineLearningInfoRequest Initializer => new MachineLearningInfoRequest();
+
+		protected override string UrlPath => $"_xpack/ml/info";
+		protected override LazyResponses ClientUsage() => Calls(
+			(client, f) => client.MachineLearningInfo(f),
+			(client, f) => client.MachineLearningInfoAsync(f),
+			(client, r) => client.MachineLearningInfo(r),
+			(client, r) => client.MachineLearningInfoAsync(r)
+		);
+
+		protected override MachineLearningInfoDescriptor NewDescriptor() => new MachineLearningInfoDescriptor();
+
+		protected override void ExpectResponse(IMachineLearningInfoResponse response)
+		{
+			response.ShouldBeValid();
+
+			response.Defaults.AnomalyDetectors.ModelMemoryLimit.Should().Be("1gb");
+			response.Defaults.AnomalyDetectors.CategorizationExamplesLimit.Should().Be(4);
+			response.Defaults.AnomalyDetectors.ModelSnapshotRetentionDays.Should().Be(1);
+
+			response.Defaults.Datafeeds.ScrollSize.Should().Be(1000);
+		}
+	}
+}

src/Tests/Tests/XPack/MachineLearning/MachineLearningInfo/MachineLearningInfoUrlTests.cs

@@ -0,0 +1,20 @@
+using System.Threading.Tasks;
+using Elastic.Xunit.XunitPlumbing;
+using Nest;
+using Tests.Framework;
+using static Tests.Framework.UrlTester;
+
+namespace Tests.XPack.MachineLearning.GetCategories
+{
+	public class InfoUrlTests : UrlTestsBase
+	{
+		[U] public override async Task Urls()
+		{
+			await GET("_xpack/ml/info")
+					.Fluent(c => c.MachineLearningInfo())
+					.Request(c => c.MachineLearningInfo(new MachineLearningInfoRequest()))
+					.FluentAsync(c => c.MachineLearningInfoAsync())
+					.RequestAsync(c => c.MachineLearningInfoAsync(new MachineLearningInfoRequest()));
+		}
+	}
+}