Skip to content

Commit a61e803

Browse files
authored
Regenerate client using 8.9 specification (#7836)
1 parent b7b9e1e commit a61e803

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2755
-172
lines changed

src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs

+4
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ internal static class ApiUrlLookup
6464
internal static ApiUrls IndexManagementCreateDataStream = new ApiUrls(new[] { "/_data_stream/{name}" });
6565
internal static ApiUrls IndexManagementCreate = new ApiUrls(new[] { "/{index}" });
6666
internal static ApiUrls IndexManagementDeleteAlias = new ApiUrls(new[] { "/{index}/_alias/{name}" });
67+
internal static ApiUrls IndexManagementDeleteDataLifecycle = new ApiUrls(new[] { "/_data_stream/{name}/_lifecycle" });
6768
internal static ApiUrls IndexManagementDeleteDataStream = new ApiUrls(new[] { "/_data_stream/{name}" });
6869
internal static ApiUrls IndexManagementDelete = new ApiUrls(new[] { "/{index}" });
6970
internal static ApiUrls IndexManagementDeleteIndexTemplate = new ApiUrls(new[] { "/_index_template/{name}" });
@@ -72,9 +73,11 @@ internal static class ApiUrlLookup
7273
internal static ApiUrls IndexManagementExistsIndexTemplate = new ApiUrls(new[] { "/_index_template/{name}" });
7374
internal static ApiUrls IndexManagementExists = new ApiUrls(new[] { "/{index}" });
7475
internal static ApiUrls IndexManagementExistsTemplate = new ApiUrls(new[] { "/_template/{name}" });
76+
internal static ApiUrls IndexManagementExplainDataLifecycle = new ApiUrls(new[] { "/{index}/_lifecycle/explain" });
7577
internal static ApiUrls IndexManagementFlush = new ApiUrls(new[] { "/_flush", "/{index}/_flush" });
7678
internal static ApiUrls IndexManagementForcemerge = new ApiUrls(new[] { "/_forcemerge", "/{index}/_forcemerge" });
7779
internal static ApiUrls IndexManagementGetAlias = new ApiUrls(new[] { "/_alias", "/_alias/{name}", "/{index}/_alias/{name}", "/{index}/_alias" });
80+
internal static ApiUrls IndexManagementGetDataLifecycle = new ApiUrls(new[] { "/_data_stream/{name}/_lifecycle" });
7881
internal static ApiUrls IndexManagementGetDataStream = new ApiUrls(new[] { "/_data_stream", "/_data_stream/{name}" });
7982
internal static ApiUrls IndexManagementGetFieldMapping = new ApiUrls(new[] { "/_mapping/field/{fields}", "/{index}/_mapping/field/{fields}" });
8083
internal static ApiUrls IndexManagementGet = new ApiUrls(new[] { "/{index}" });
@@ -85,6 +88,7 @@ internal static class ApiUrlLookup
8588
internal static ApiUrls IndexManagementMigrateToDataStream = new ApiUrls(new[] { "/_data_stream/_migrate/{name}" });
8689
internal static ApiUrls IndexManagementOpen = new ApiUrls(new[] { "/{index}/_open" });
8790
internal static ApiUrls IndexManagementPutAlias = new ApiUrls(new[] { "/{index}/_alias/{name}" });
91+
internal static ApiUrls IndexManagementPutDataLifecycle = new ApiUrls(new[] { "/_data_stream/{name}/_lifecycle" });
8892
internal static ApiUrls IndexManagementPutIndexTemplate = new ApiUrls(new[] { "/_index_template/{name}" });
8993
internal static ApiUrls IndexManagementPutMapping = new ApiUrls(new[] { "/{index}/_mapping" });
9094
internal static ApiUrls IndexManagementPutTemplate = new ApiUrls(new[] { "/_template/{name}" });

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public sealed class AsyncSearchStatusRequestParameters : RequestParameters
3434
}
3535

3636
/// <summary>
37-
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
37+
/// <para>Retreives the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
3838
/// </summary>
3939
public sealed partial class AsyncSearchStatusRequest : PlainRequest<AsyncSearchStatusRequestParameters>
4040
{
@@ -50,7 +50,7 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
5050
}
5151

5252
/// <summary>
53-
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
53+
/// <para>Retreives the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
5454
/// </summary>
5555
public sealed partial class AsyncSearchStatusRequestDescriptor<TDocument> : RequestDescriptor<AsyncSearchStatusRequestDescriptor<TDocument>, AsyncSearchStatusRequestParameters>
5656
{
@@ -82,7 +82,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
8282
}
8383

8484
/// <summary>
85-
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
85+
/// <para>Retreives the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
8686
/// </summary>
8787
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor<AsyncSearchStatusRequestDescriptor, AsyncSearchStatusRequestParameters>
8888
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs

+7
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch;
2828

2929
public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
3030
{
31+
/// <summary>
32+
/// <para>If the async search completed, this field shows the status code of the search.<br/>For example, 200 indicates that the async search was successfully completed.<br/>503 indicates that the async search was completed with an error.</para>
33+
/// </summary>
3134
[JsonInclude, JsonPropertyName("completion_status")]
3235
public int? CompletionStatus { get; init; }
3336
[JsonInclude, JsonPropertyName("expiration_time")]
@@ -40,6 +43,10 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
4043
public bool IsPartial { get; init; }
4144
[JsonInclude, JsonPropertyName("is_running")]
4245
public bool IsRunning { get; init; }
46+
47+
/// <summary>
48+
/// <para>Indicates how many shards have run the query so far.</para>
49+
/// </summary>
4350
[JsonInclude, JsonPropertyName("_shards")]
4451
public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; }
4552
[JsonInclude, JsonPropertyName("start_time")]

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public sealed class DeleteAsyncSearchRequestParameters : RequestParameters
3434
}
3535

3636
/// <summary>
37-
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.</para>
37+
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.</para>
3838
/// </summary>
3939
public sealed partial class DeleteAsyncSearchRequest : PlainRequest<DeleteAsyncSearchRequestParameters>
4040
{
@@ -50,7 +50,7 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
5050
}
5151

5252
/// <summary>
53-
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.</para>
53+
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.</para>
5454
/// </summary>
5555
public sealed partial class DeleteAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<DeleteAsyncSearchRequestDescriptor<TDocument>, DeleteAsyncSearchRequestParameters>
5656
{
@@ -82,7 +82,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
8282
}
8383

8484
/// <summary>
85-
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.</para>
85+
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.</para>
8686
/// </summary>
8787
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor<DeleteAsyncSearchRequestDescriptor, DeleteAsyncSearchRequestParameters>
8888
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch;
3232
public sealed class GetAsyncSearchRequestParameters : RequestParameters
3333
{
3434
/// <summary>
35-
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
35+
/// <para>Specifies how long the async search should be available in the cluster.<br/>When not specified, the `keep_alive` set with the corresponding submit async request will be used.<br/>Otherwise, it is possible to override the value and extend the validity of the request.<br/>When this period expires, the search, if still running, is cancelled.<br/>If the search is completed, its saved results are deleted.</para>
3636
/// </summary>
3737
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
3838

@@ -42,13 +42,13 @@ public sealed class GetAsyncSearchRequestParameters : RequestParameters
4242
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
4343

4444
/// <summary>
45-
/// <para>Specify the time that the request should block waiting for the final response</para>
45+
/// <para>Specifies to wait for the search to be completed up until the provided timeout.<br/>Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.<br/>By default no timeout is set meaning that the currently available results will be returned without any additional wait.</para>
4646
/// </summary>
4747
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
4848
}
4949

5050
/// <summary>
51-
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
51+
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
5252
/// </summary>
5353
public sealed partial class GetAsyncSearchRequest : PlainRequest<GetAsyncSearchRequestParameters>
5454
{
@@ -63,7 +63,7 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.
6363
internal override bool SupportsBody => false;
6464

6565
/// <summary>
66-
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
66+
/// <para>Specifies how long the async search should be available in the cluster.<br/>When not specified, the `keep_alive` set with the corresponding submit async request will be used.<br/>Otherwise, it is possible to override the value and extend the validity of the request.<br/>When this period expires, the search, if still running, is cancelled.<br/>If the search is completed, its saved results are deleted.</para>
6767
/// </summary>
6868
[JsonIgnore]
6969
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
@@ -75,14 +75,14 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.
7575
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
7676

7777
/// <summary>
78-
/// <para>Specify the time that the request should block waiting for the final response</para>
78+
/// <para>Specifies to wait for the search to be completed up until the provided timeout.<br/>Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.<br/>By default no timeout is set meaning that the currently available results will be returned without any additional wait.</para>
7979
/// </summary>
8080
[JsonIgnore]
8181
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
8282
}
8383

8484
/// <summary>
85-
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
85+
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
8686
/// </summary>
8787
public sealed partial class GetAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<GetAsyncSearchRequestDescriptor<TDocument>, GetAsyncSearchRequestParameters>
8888
{
@@ -118,7 +118,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
118118
}
119119

120120
/// <summary>
121-
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
121+
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
122122
/// </summary>
123123
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor<GetAsyncSearchRequestDescriptor, GetAsyncSearchRequestParameters>
124124
{

0 commit comments

Comments
 (0)