Skip to content

Commit 2e3ed0f

Browse files
stevejgordonstevejgordon
committed
Add NEST support for EQL Get Search API (#5665)
* Add initial request and response * Generate code for EQL get status * Add test, update naming and headers * Add initial types * Generate code * Add tests (cherry picked from commit 3d1a3b2)
1 parent 63cb9b6 commit 2e3ed0f

File tree

12 files changed

+246
-7
lines changed

12 files changed

+246
-7
lines changed

‎src/Elasticsearch.Net/Api/RequestParameters/RequestParameters.Eql.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public class DeleteRequestParameters : RequestParameters<DeleteRequestParameters
4949
}
5050

5151
///<summary>Request options for Get <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
52-
public class GetRequestParameters : RequestParameters<GetRequestParameters>
52+
public class EqlGetRequestParameters : RequestParameters<EqlGetRequestParameters>
5353
{
5454
///<summary>Update the time interval in which the results (partial or final) for this search will be available</summary>
5555
public TimeSpan KeepAlive

‎src/Elasticsearch.Net/ElasticLowLevelClient.Eql.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,14 @@ public Task<TResponse> DeleteAsync<TResponse>(string id, DeleteRequestParameters
7676
///<summary>GET on /_eql/search/{id} <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
7777
///<param name = "id">The async search ID</param>
7878
///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
79-
public TResponse Get<TResponse>(string id, GetRequestParameters requestParameters = null)
80-
where TResponse : class, ITransportResponse, new() => DoRequest<TResponse>(GET, Url($"_eql/search/{id:id}"), null, RequestParams(requestParameters));
79+
public TResponse Get<TResponse>(string id, EqlGetRequestParameters requestParameters = null)
80+
where TResponse : class, IElasticsearchResponse, new() => DoRequest<TResponse>(GET, Url($"_eql/search/{id:id}"), null, RequestParams(requestParameters));
8181
///<summary>GET on /_eql/search/{id} <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
8282
///<param name = "id">The async search ID</param>
8383
///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>
8484
[MapsApi("eql.get", "id")]
85-
public Task<TResponse> GetAsync<TResponse>(string id, GetRequestParameters requestParameters = null, CancellationToken ctx = default)
86-
where TResponse : class, ITransportResponse, new() => DoRequestAsync<TResponse>(GET, Url($"_eql/search/{id:id}"), ctx, null, RequestParams(requestParameters));
85+
public Task<TResponse> GetAsync<TResponse>(string id, EqlGetRequestParameters requestParameters = null, CancellationToken ctx = default)
86+
where TResponse : class, IElasticsearchResponse, new() => DoRequestAsync<TResponse>(GET, Url($"_eql/search/{id:id}"), ctx, null, RequestParams(requestParameters));
8787
///<summary>GET on /_eql/search/status/{id} <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
8888
///<param name = "id">The async search ID</param>
8989
///<param name = "requestParameters">Request specific configuration such as querystring parameters &amp; request specific connection settings.</param>

‎src/Nest/Descriptors.Eql.cs‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,31 @@
4949
// ReSharper disable RedundantNameQualifier
5050
namespace Nest
5151
{
52+
///<summary>Descriptor for Get <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
53+
public partial class EqlGetDescriptor : RequestDescriptorBase<EqlGetDescriptor, EqlGetRequestParameters, IEqlGetRequest>, IEqlGetRequest
54+
{
55+
internal override ApiUrls ApiUrls => ApiUrlsLookups.EqlGet;
56+
///<summary>/_eql/search/{id}</summary>
57+
///<param name = "id">this parameter is required</param>
58+
public EqlGetDescriptor(Id id): base(r => r.Required("id", id))
59+
{
60+
}
61+
62+
///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
63+
[SerializationConstructor]
64+
protected EqlGetDescriptor(): base()
65+
{
66+
}
67+
68+
// values part of the url path
69+
Id IEqlGetRequest.Id => Self.RouteValues.Get<Id>("id");
70+
// Request parameters
71+
///<summary>Update the time interval in which the results (partial or final) for this search will be available</summary>
72+
public EqlGetDescriptor KeepAlive(Time keepalive) => Qs("keep_alive", keepalive);
73+
///<summary>Specify the time that the request should block waiting for the final response</summary>
74+
public EqlGetDescriptor WaitForCompletionTimeout(Time waitforcompletiontimeout) => Qs("wait_for_completion_timeout", waitforcompletiontimeout);
75+
}
76+
5277
///<summary>Descriptor for SearchStatus <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
5378
public partial class EqlSearchStatusDescriptor : RequestDescriptorBase<EqlSearchStatusDescriptor, EqlSearchStatusRequestParameters, IEqlSearchStatusRequest>, IEqlSearchStatusRequest
5479
{

‎src/Nest/ElasticClient.Eql.cs‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,34 @@ internal EqlNamespace(ElasticClient client): base(client)
5454
{
5555
}
5656

57+
/// <summary>
58+
/// <c>GET</c> request to the <c>eql.get</c> API, read more about this API online:
59+
/// <para></para>
60+
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</a>
61+
/// </summary>
62+
public EqlGetResponse<TDocument> Get<TDocument>(Id id, Func<EqlGetDescriptor, IEqlGetRequest> selector = null)
63+
where TDocument : class => Get<TDocument>(selector.InvokeOrDefault(new EqlGetDescriptor(id: id)));
64+
/// <summary>
65+
/// <c>GET</c> request to the <c>eql.get</c> API, read more about this API online:
66+
/// <para></para>
67+
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</a>
68+
/// </summary>
69+
public Task<EqlGetResponse<TDocument>> GetAsync<TDocument>(Id id, Func<EqlGetDescriptor, IEqlGetRequest> selector = null, CancellationToken ct = default)
70+
where TDocument : class => GetAsync<TDocument>(selector.InvokeOrDefault(new EqlGetDescriptor(id: id)), ct);
71+
/// <summary>
72+
/// <c>GET</c> request to the <c>eql.get</c> API, read more about this API online:
73+
/// <para></para>
74+
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</a>
75+
/// </summary>
76+
public EqlGetResponse<TDocument> Get<TDocument>(IEqlGetRequest request)
77+
where TDocument : class => DoRequest<IEqlGetRequest, EqlGetResponse<TDocument>>(request, request.RequestParameters);
78+
/// <summary>
79+
/// <c>GET</c> request to the <c>eql.get</c> API, read more about this API online:
80+
/// <para></para>
81+
/// <a href = "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html">https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</a>
82+
/// </summary>
83+
public Task<EqlGetResponse<TDocument>> GetAsync<TDocument>(IEqlGetRequest request, CancellationToken ct = default)
84+
where TDocument : class => DoRequestAsync<IEqlGetRequest, EqlGetResponse<TDocument>>(request, request.RequestParameters, ct);
5785
/// <summary>
5886
/// <c>GET</c> request to the <c>eql.get_status</c> API, read more about this API online:
5987
/// <para></para>

‎src/Nest/Requests.Eql.cs‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,52 @@
5050
// ReSharper disable RedundantNameQualifier
5151
namespace Nest
5252
{
53+
[InterfaceDataContract]
54+
public partial interface IEqlGetRequest : IRequest<EqlGetRequestParameters>
55+
{
56+
[IgnoreDataMember]
57+
Id Id
58+
{
59+
get;
60+
}
61+
}
62+
63+
///<summary>Request for Get <para>https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html</para></summary>
64+
public partial class EqlGetRequest : PlainRequestBase<EqlGetRequestParameters>, IEqlGetRequest
65+
{
66+
protected IEqlGetRequest Self => this;
67+
internal override ApiUrls ApiUrls => ApiUrlsLookups.EqlGet;
68+
///<summary>/_eql/search/{id}</summary>
69+
///<param name = "id">this parameter is required</param>
70+
public EqlGetRequest(Id id): base(r => r.Required("id", id))
71+
{
72+
}
73+
74+
///<summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
75+
[SerializationConstructor]
76+
protected EqlGetRequest(): base()
77+
{
78+
}
79+
80+
// values part of the url path
81+
[IgnoreDataMember]
82+
Id IEqlGetRequest.Id => Self.RouteValues.Get<Id>("id");
83+
// Request parameters
84+
///<summary>Update the time interval in which the results (partial or final) for this search will be available</summary>
85+
public Time KeepAlive
86+
{
87+
get => Q<Time>("keep_alive");
88+
set => Q("keep_alive", value);
89+
}
90+
91+
///<summary>Specify the time that the request should block waiting for the final response</summary>
92+
public Time WaitForCompletionTimeout
93+
{
94+
get => Q<Time>("wait_for_completion_timeout");
95+
set => Q("wait_for_completion_timeout", value);
96+
}
97+
}
98+
5399
[InterfaceDataContract]
54100
public partial interface IEqlSearchStatusRequest : IRequest<EqlSearchStatusRequestParameters>
55101
{

‎src/Nest/XPack/Eql/Search/EqlSearchResponse.cs‎ renamed to ‎src/Nest/XPack/Eql/EqlSearchResponse.cs‎

File renamed without changes.

‎src/Nest/XPack/Eql/Get/EqlGetRequest.cs‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
namespace Nest
21+
{
22+
[MapsApi("eql.get.json")]
23+
[ReadAs(typeof(EqlGetRequest))]
24+
public partial interface IEqlGetRequest { }
25+
26+
public partial class EqlGetRequest { }
27+
28+
public partial class EqlGetDescriptor { }
29+
}

‎src/Nest/XPack/Eql/Get/EqlGetResponse.cs‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
namespace Nest
21+
{
22+
/// <summary>
23+
/// A response to an EQL get async search request.
24+
/// </summary>
25+
public class EqlGetResponse<TDocument> : EqlSearchResponse<TDocument> where TDocument : class
26+
{
27+
}
28+
}

‎src/Nest/_Generated/ApiUrlsLookup.generated.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ internal static class ApiUrlsLookups
106106
internal static ApiUrls EnrichGetPolicy = new ApiUrls(new[]{"_enrich/policy/{name}", "_enrich/policy"});
107107
internal static ApiUrls EnrichPutPolicy = new ApiUrls(new[]{"_enrich/policy/{name}"});
108108
internal static ApiUrls EnrichStats = new ApiUrls(new[]{"_enrich/_stats"});
109+
internal static ApiUrls EqlGet = new ApiUrls(new[]{"_eql/search/{id}"});
109110
internal static ApiUrls EqlSearchStatus = new ApiUrls(new[]{"_eql/search/status/{id}"});
110111
internal static ApiUrls EqlSearch = new ApiUrls(new[]{"{index}/_eql/search"});
111112
internal static ApiUrls NoNamespaceDocumentExists = new ApiUrls(new[]{"{index}/_doc/{id}"});

‎tests/Tests.Configuration/tests.default.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
# tracked by git).
66

77
# mode either u (unit test), i (integration test) or m (mixed mode)
8-
mode: i
8+
mode: u
99

1010
# the elasticsearch version that should be started
1111
# Can be a snapshot version of sonatype or "latest" to get the latest snapshot of sonatype
12-
elasticsearch_version: 7.13.0-SNAPSHOT
12+
elasticsearch_version: latest
1313
# cluster filter allows you to only run the integration tests of a particular cluster (cluster suffix not needed)
1414
# cluster_filter:
1515
# whether we want to forcefully reseed on the node, if you are starting the tests with a node already running

0 commit comments

Comments
 (0)