Implement cat.ml_datafeeds (#4564) (#4615)

Implement cat.ml_datafeeds

Co-authored-by: Stuart Cam <stuart.cam@elastic.co>

Author: github-actions[bot]

src/ApiGenerator/Configuration/CodeConfiguration.cs

@@ -59,7 +59,6 @@ public static class CodeConfiguration
 			"async_search.get.json",
 			"async_search.submit.json",
 			"cat.ml_data_frame_analytics.json",
-			"cat.ml_datafeeds.json",
 			"cluster.delete_component_template.json",
 			"cluster.get_component_template.json",
 			"cluster.put_component_template.json",

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

@@ -537,8 +537,8 @@ public bool? Verbose
 		}
 	}
 
-	///<summary>Request options for MlDatafeeds <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
-	public class MlDatafeedsRequestParameters : RequestParameters<MlDatafeedsRequestParameters>
+	///<summary>Request options for Datafeeds <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
+	public class CatDatafeedsRequestParameters : RequestParameters<CatDatafeedsRequestParameters>
 	{
 		public override HttpMethod DefaultHttpMethod => HttpMethod.GET;
 		public override bool SupportsBody => false;

src/Elasticsearch.Net/ElasticLowLevelClient.Cat.cs

@@ -198,23 +198,23 @@ public Task<TResponse> MlDataFrameAnalyticsAsync<TResponse>(string id, MlDataFra
 			where TResponse : class, IElasticsearchResponse, new() => DoRequestAsync<TResponse>(GET, Url($"_cat/ml/data_frame/analytics/{id:id}"), ctx, null, RequestParams(requestParameters));
 		///<summary>GET on /_cat/ml/datafeeds <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
 		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
-		public TResponse MlDatafeeds<TResponse>(MlDatafeedsRequestParameters requestParameters = null)
+		public TResponse Datafeeds<TResponse>(CatDatafeedsRequestParameters requestParameters = null)
 			where TResponse : class, IElasticsearchResponse, new() => DoRequest<TResponse>(GET, "_cat/ml/datafeeds", null, RequestParams(requestParameters));
 		///<summary>GET on /_cat/ml/datafeeds <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
 		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
 		[MapsApi("cat.ml_datafeeds", "")]
-		public Task<TResponse> MlDatafeedsAsync<TResponse>(MlDatafeedsRequestParameters requestParameters = null, CancellationToken ctx = default)
+		public Task<TResponse> DatafeedsAsync<TResponse>(CatDatafeedsRequestParameters requestParameters = null, CancellationToken ctx = default)
 			where TResponse : class, IElasticsearchResponse, new() => DoRequestAsync<TResponse>(GET, "_cat/ml/datafeeds", ctx, null, RequestParams(requestParameters));
 		///<summary>GET on /_cat/ml/datafeeds/{datafeed_id} <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
 		///<param name = "datafeedId">The ID of the datafeeds stats to fetch</param>
 		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
-		public TResponse MlDatafeeds<TResponse>(string datafeedId, MlDatafeedsRequestParameters requestParameters = null)
+		public TResponse Datafeeds<TResponse>(string datafeedId, CatDatafeedsRequestParameters requestParameters = null)
 			where TResponse : class, IElasticsearchResponse, new() => DoRequest<TResponse>(GET, Url($"_cat/ml/datafeeds/{datafeedId:datafeedId}"), null, RequestParams(requestParameters));
 		///<summary>GET on /_cat/ml/datafeeds/{datafeed_id} <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
 		///<param name = "datafeedId">The ID of the datafeeds stats to fetch</param>
 		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
 		[MapsApi("cat.ml_datafeeds", "datafeed_id")]
-		public Task<TResponse> MlDatafeedsAsync<TResponse>(string datafeedId, MlDatafeedsRequestParameters requestParameters = null, CancellationToken ctx = default)
+		public Task<TResponse> DatafeedsAsync<TResponse>(string datafeedId, CatDatafeedsRequestParameters requestParameters = null, CancellationToken ctx = default)
 			where TResponse : class, IElasticsearchResponse, new() => DoRequestAsync<TResponse>(GET, Url($"_cat/ml/datafeeds/{datafeedId:datafeedId}"), ctx, null, RequestParams(requestParameters));
 		///<summary>GET on /_cat/ml/anomaly_detectors <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html</para></summary>
 		///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>

src/Nest/Cat/CatDatafeeds/CatDatafeedsRecord.cs

@@ -0,0 +1,82 @@
+using System.Runtime.Serialization;
+using Elasticsearch.Net.Utf8Json;
+
+namespace Nest
+{
+	[DataContract]
+	public class CatDatafeedsRecord : ICatRecord
+	{
+		/// <summary>
+		/// For started datafeeds only, contains messages relating to the selection of a node.
+		/// </summary>
+		[DataMember(Name="assignment_explanation")]
+		public string AssignmentExplanation { get; internal set; }
+
+		/// <summary>
+		/// (Default) The number of buckets processed.
+		/// </summary>
+		[DataMember(Name="buckets.count")]
+		public string BucketsCount { get; internal set; }
+
+		/// <summary>
+		/// (Default) A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric
+		/// characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
+		/// </summary>
+		[DataMember(Name="id")]
+		public string Id { get; internal set; }
+
+		/// <summary>
+		/// The network address of the node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
+		/// </summary>
+		[DataMember(Name="node.address")]
+		public string NodeAddress { get; internal set; }
+
+		/// <summary>
+		/// The ephemeral ID of the node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
+		/// </summary>
+		[DataMember(Name="node.ephemeral_id")]
+		public string NodeEphemeralId { get; internal set; }
+
+		/// <summary>
+		/// The unique identifier of the node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
+		/// </summary>
+		[DataMember(Name="node.id")]
+		public string NodeId { get; internal set; }
+
+		/// <summary>
+		/// The node name. For started datafeeds only, this information pertains to the node upon which the datafeed is started.
+		/// </summary>
+		[DataMember(Name="node.name")]
+		public string NodeName { get; internal set; }
+
+		/// <summary>
+		/// The average search time per bucket, in milliseconds.
+		/// </summary>
+		[DataMember(Name="search.bucket_avg")]
+		public string SearchBucketAvg { get; internal set; }
+
+		/// <summary>
+		/// (Default) The number of searches run by the datafeed.
+		/// </summary>
+		[DataMember(Name="search.count")]
+		public string SearchCount { get; internal set; }
+
+		/// <summary>
+		/// The exponential average search time per hour, in milliseconds.
+		/// </summary>
+		[DataMember(Name="search.exp_avg_hour")]
+		public string SearchExpAvgHour { get; internal set; }
+
+		/// <summary>
+		/// The total time the datafeed spent searching, in milliseconds.
+		/// </summary>
+		[DataMember(Name="search.time")]
+		public string SearchTime { get; internal set; }
+
+		/// <summary>
+		/// The status of the datafeed.
+		/// </summary>
+		[DataMember(Name="state")]
+		public DatafeedState State { get; internal set; }
+	}
+}

src/Nest/Cat/CatDatafeeds/CatDatafeedsRequest.cs

@@ -0,0 +1,9 @@
+namespace Nest
+{
+	[MapsApi("cat.ml_datafeeds.json")]
+	public partial interface ICatDatafeedsRequest { }
+
+	public partial class CatDatafeedsRequest { }
+
+	public partial class CatDatafeedsDescriptor { }
+}

src/Nest/Descriptors.Cat.cs

@@ -278,6 +278,40 @@ public partial class CatMasterDescriptor : RequestDescriptorBase<CatMasterDescri
 		public CatMasterDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
 	}
 
+	///<summary>Descriptor for Datafeeds <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
+	public partial class CatDatafeedsDescriptor : RequestDescriptorBase<CatDatafeedsDescriptor, CatDatafeedsRequestParameters, ICatDatafeedsRequest>, ICatDatafeedsRequest
+	{
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.CatDatafeeds;
+		///<summary>/_cat/ml/datafeeds</summary>
+		public CatDatafeedsDescriptor(): base()
+		{
+		}
+
+		///<summary>/_cat/ml/datafeeds/{datafeed_id}</summary>
+		///<param name = "datafeedId">Optional, accepts null</param>
+		public CatDatafeedsDescriptor(Id datafeedId): base(r => r.Optional("datafeed_id", datafeedId))
+		{
+		}
+
+		// values part of the url path
+		Id ICatDatafeedsRequest.DatafeedId => Self.RouteValues.Get<Id>("datafeed_id");
+		///<summary>The ID of the datafeeds stats to fetch</summary>
+		public CatDatafeedsDescriptor DatafeedId(Id datafeedId) => Assign(datafeedId, (a, v) => a.RouteValues.Optional("datafeed_id", v));
+		// Request parameters
+		///<summary>Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)</summary>
+		public CatDatafeedsDescriptor AllowNoDatafeeds(bool? allownodatafeeds = true) => Qs("allow_no_datafeeds", allownodatafeeds);
+		///<summary>a short version of the Accept header, e.g. json, yaml</summary>
+		public CatDatafeedsDescriptor Format(string format) => Qs("format", format);
+		///<summary>Comma-separated list of column names to display</summary>
+		public CatDatafeedsDescriptor Headers(params string[] headers) => Qs("h", headers);
+		///<summary>Return help information</summary>
+		public CatDatafeedsDescriptor Help(bool? help = true) => Qs("help", help);
+		///<summary>Comma-separated list of column names or column aliases to sort by</summary>
+		public CatDatafeedsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
+		///<summary>Verbose mode. Display column headers</summary>
+		public CatDatafeedsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
+	}
+
 	///<summary>Descriptor for Jobs <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html</para></summary>
 	public partial class CatJobsDescriptor : RequestDescriptorBase<CatJobsDescriptor, CatJobsRequestParameters, ICatJobsRequest>, ICatJobsRequest
 	{

src/Nest/ElasticClient.Cat.cs

@@ -229,6 +229,30 @@ internal CatNamespace(ElasticClient client): base(client)
 		/// </summary>
 		public Task<CatResponse<CatMasterRecord>> MasterAsync(ICatMasterRequest request, CancellationToken ct = default) => DoCatAsync<ICatMasterRequest, CatMasterRequestParameters, CatMasterRecord>(request, ct);
 		/// <summary>
+		/// <c>GET</c> request to the <c>cat.ml_datafeeds</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</a>
+		/// </summary>
+		public CatResponse<CatDatafeedsRecord> Datafeeds(Func<CatDatafeedsDescriptor, ICatDatafeedsRequest> selector = null) => Datafeeds(selector.InvokeOrDefault(new CatDatafeedsDescriptor()));
+		/// <summary>
+		/// <c>GET</c> request to the <c>cat.ml_datafeeds</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</a>
+		/// </summary>
+		public Task<CatResponse<CatDatafeedsRecord>> DatafeedsAsync(Func<CatDatafeedsDescriptor, ICatDatafeedsRequest> selector = null, CancellationToken ct = default) => DatafeedsAsync(selector.InvokeOrDefault(new CatDatafeedsDescriptor()), ct);
+		/// <summary>
+		/// <c>GET</c> request to the <c>cat.ml_datafeeds</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</a>
+		/// </summary>
+		public CatResponse<CatDatafeedsRecord> Datafeeds(ICatDatafeedsRequest request) => DoCat<ICatDatafeedsRequest, CatDatafeedsRequestParameters, CatDatafeedsRecord>(request);
+		/// <summary>
+		/// <c>GET</c> request to the <c>cat.ml_datafeeds</c> API, read more about this API online:
+		/// <para></para>
+		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</a>
+		/// </summary>
+		public Task<CatResponse<CatDatafeedsRecord>> DatafeedsAsync(ICatDatafeedsRequest request, CancellationToken ct = default) => DoCatAsync<ICatDatafeedsRequest, CatDatafeedsRequestParameters, CatDatafeedsRecord>(request, ct);
+		/// <summary>
 		/// <c>GET</c> request to the <c>cat.ml_jobs</c> API, read more about this API online:
 		/// <para></para>
 		/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html</a>

src/Nest/Requests.Cat.cs

@@ -610,6 +610,83 @@ public bool? Verbose
 		}
 	}
 
+	[InterfaceDataContract]
+	public partial interface ICatDatafeedsRequest : IRequest<CatDatafeedsRequestParameters>
+	{
+		[IgnoreDataMember]
+		Id DatafeedId
+		{
+			get;
+		}
+	}
+
+	///<summary>Request for Datafeeds <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html</para></summary>
+	public partial class CatDatafeedsRequest : PlainRequestBase<CatDatafeedsRequestParameters>, ICatDatafeedsRequest
+	{
+		protected ICatDatafeedsRequest Self => this;
+		internal override ApiUrls ApiUrls => ApiUrlsLookups.CatDatafeeds;
+		///<summary>/_cat/ml/datafeeds</summary>
+		public CatDatafeedsRequest(): base()
+		{
+		}
+
+		///<summary>/_cat/ml/datafeeds/{datafeed_id}</summary>
+		///<param name = "datafeedId">Optional, accepts null</param>
+		public CatDatafeedsRequest(Id datafeedId): base(r => r.Optional("datafeed_id", datafeedId))
+		{
+		}
+
+		// values part of the url path
+		[IgnoreDataMember]
+		Id ICatDatafeedsRequest.DatafeedId => Self.RouteValues.Get<Id>("datafeed_id");
+		// Request parameters
+		///<summary>Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)</summary>
+		public bool? AllowNoDatafeeds
+		{
+			get => Q<bool? >("allow_no_datafeeds");
+			set => Q("allow_no_datafeeds", value);
+		}
+
+		///<summary>a short version of the Accept header, e.g. json, yaml</summary>
+		public string Format
+		{
+			get => Q<string>("format");
+			set
+			{
+				Q("format", value);
+				SetAcceptHeader(value);
+			}
+		}
+
+		///<summary>Comma-separated list of column names to display</summary>
+		public string[] Headers
+		{
+			get => Q<string[]>("h");
+			set => Q("h", value);
+		}
+
+		///<summary>Return help information</summary>
+		public bool? Help
+		{
+			get => Q<bool? >("help");
+			set => Q("help", value);
+		}
+
+		///<summary>Comma-separated list of column names or column aliases to sort by</summary>
+		public string[] SortByColumns
+		{
+			get => Q<string[]>("s");
+			set => Q("s", value);
+		}
+
+		///<summary>Verbose mode. Display column headers</summary>
+		public bool? Verbose
+		{
+			get => Q<bool? >("v");
+			set => Q("v", value);
+		}
+	}
+
 	[InterfaceDataContract]
 	public partial interface ICatJobsRequest : IRequest<CatJobsRequestParameters>
 	{

src/Nest/XPack/MachineLearning/Datafeed/DatafeedState.cs

@@ -4,18 +4,33 @@
 
 namespace Nest
 {
+	/// <summary>
+	/// The status of the datafeed
+	/// </summary>
 	[StringEnum]
 	public enum DatafeedState
 	{
+		/// <summary>
+		/// The datafeed is actively receiving data.
+		/// </summary>
 		[EnumMember(Value = "started")]
 		Started,
 
+		/// <summary>
+		/// The datafeed is stopped and will not receive data until it is re-started.
+		/// </summary>
 		[EnumMember(Value = "stopped")]
 		Stopped,
 
+		/// <summary>
+		/// The datafeed has been requested to start but has not yet started.
+		/// </summary>
 		[EnumMember(Value = "starting")]
 		Starting,
 
+		/// <summary>
+		/// The datafeed has been requested to stop gracefully and is completing its final action.
+		/// </summary>
 		[EnumMember(Value = "stopping")]
 		Stopping
 	}

src/Nest/_Generated/ApiUrlsLookup.generated.cs

@@ -28,7 +28,7 @@ internal static class ApiUrlsLookups
 		internal static ApiUrls CatIndices = new ApiUrls(new[]{"_cat/indices", "_cat/indices/{index}"});
 		internal static ApiUrls CatMaster = new ApiUrls(new[]{"_cat/master"});
 		internal static ApiUrls CatMlDataFrameAnalytics = new ApiUrls(new[]{"_cat/ml/data_frame/analytics", "_cat/ml/data_frame/analytics/{id}"});
-		internal static ApiUrls CatMlDatafeeds = new ApiUrls(new[]{"_cat/ml/datafeeds", "_cat/ml/datafeeds/{datafeed_id}"});
+		internal static ApiUrls CatDatafeeds = new ApiUrls(new[]{"_cat/ml/datafeeds", "_cat/ml/datafeeds/{datafeed_id}"});
 		internal static ApiUrls CatJobs = new ApiUrls(new[]{"_cat/ml/anomaly_detectors", "_cat/ml/anomaly_detectors/{job_id}"});
 		internal static ApiUrls CatTrainedModels = new ApiUrls(new[]{"_cat/ml/trained_models", "_cat/ml/trained_models/{model_id}"});
 		internal static ApiUrls CatNodeAttributes = new ApiUrls(new[]{"_cat/nodeattrs"});

tests/Tests/Cat/CatDatafeeds/CatDatafeedsApiTests.cs

@@ -0,0 +1,41 @@
+using Elastic.Xunit.XunitPlumbing;
+using Elasticsearch.Net;
+using Nest;
+using Tests.Core.Extensions;
+using Tests.Framework.EndpointTests.TestState;
+using Tests.XPack.MachineLearning;
+
+namespace Tests.Cat.CatDatafeeds
+{
+	[SkipVersion("<7.7.0", "Introduced in 7.7.0")]
+	public class CatDatafeedsApiTests
+		: MachineLearningIntegrationTestBase<CatResponse<CatDatafeedsRecord>, ICatDatafeedsRequest, CatDatafeedsDescriptor,
+			CatDatafeedsRequest>
+	{
+		public CatDatafeedsApiTests(MachineLearningCluster cluster, EndpointUsage usage) : base(cluster, usage) { }
+
+		protected override void IntegrationSetup(IElasticClient client, CallUniqueValues values)
+		{
+			foreach (var callUniqueValue in values)
+			{
+				PutJob(client, callUniqueValue.Value);
+				OpenJob(client, callUniqueValue.Value);
+				PutDatafeed(client, callUniqueValue.Value);
+			}
+		}
+
+		protected override bool ExpectIsValid => true;
+		protected override int ExpectStatusCode => 200;
+		protected override HttpMethod HttpMethod => HttpMethod.GET;
+		protected override string UrlPath => "/_cat/ml/datafeeds";
+
+		protected override LazyResponses ClientUsage() => Calls(
+			(client, f) => client.Cat.Datafeeds(),
+			(client, f) => client.Cat.DatafeedsAsync(),
+			(client, r) => client.Cat.Datafeeds(r),
+			(client, r) => client.Cat.DatafeedsAsync(r)
+		);
+
+		protected override void ExpectResponse(CatResponse<CatDatafeedsRecord> response) => response.ShouldBeValid();
+	}
+}