Skip to content

Commit 60cdd9e

Browse files
committed
Regenerate client using the latest specification
1 parent 736c4cd commit 60cdd9e

File tree

273 files changed

+9444
-1113
lines changed

Some content is hidden

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

273 files changed

+9444
-1113
lines changed

src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsRequest.g.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Cluster;
3232
public sealed class ClusterStatsRequestParameters : RequestParameters
3333
{
3434
/// <summary>
35-
/// <para>Return settings in flat format (default: false)</para>
35+
/// <para>If `true`, returns settings in flat format.</para>
3636
/// </summary>
3737
public bool? FlatSettings { get => Q<bool?>("flat_settings"); set => Q("flat_settings", value); }
3838

3939
/// <summary>
40-
/// <para>Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.</para>
40+
/// <para>Period to wait for each node to respond.<br/>If a node does not respond before its timeout expires, the response does not include its stats.<br/>However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.</para>
4141
/// </summary>
4242
public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("timeout"); set => Q("timeout", value); }
4343
}
4444

4545
/// <summary>
46-
/// <para>Returns high-level overview of cluster statistics.</para>
46+
/// <para>Returns cluster statistics.<br/>It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).</para>
4747
/// </summary>
4848
public sealed partial class ClusterStatsRequest : PlainRequest<ClusterStatsRequestParameters>
4949
{
@@ -62,20 +62,20 @@ public ClusterStatsRequest(Elastic.Clients.Elasticsearch.NodeIds? node_id) : bas
6262
internal override bool SupportsBody => false;
6363

6464
/// <summary>
65-
/// <para>Return settings in flat format (default: false)</para>
65+
/// <para>If `true`, returns settings in flat format.</para>
6666
/// </summary>
6767
[JsonIgnore]
6868
public bool? FlatSettings { get => Q<bool?>("flat_settings"); set => Q("flat_settings", value); }
6969

7070
/// <summary>
71-
/// <para>Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.</para>
71+
/// <para>Period to wait for each node to respond.<br/>If a node does not respond before its timeout expires, the response does not include its stats.<br/>However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout.</para>
7272
/// </summary>
7373
[JsonIgnore]
7474
public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("timeout"); set => Q("timeout", value); }
7575
}
7676

7777
/// <summary>
78-
/// <para>Returns high-level overview of cluster statistics.</para>
78+
/// <para>Returns cluster statistics.<br/>It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).</para>
7979
/// </summary>
8080
public sealed partial class ClusterStatsRequestDescriptor : RequestDescriptor<ClusterStatsRequestDescriptor, ClusterStatsRequestParameters>
8181
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/ClusterStatsResponse.g.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ namespace Elastic.Clients.Elasticsearch.Cluster;
2828
public sealed partial class ClusterStatsResponse : ElasticsearchResponse
2929
{
3030
/// <summary>
31-
/// <para>Name of the cluster, based on the Cluster name setting setting.</para>
31+
/// <para>Name of the cluster, based on the cluster name setting.</para>
3232
/// </summary>
3333
[JsonInclude, JsonPropertyName("cluster_name")]
3434
public string ClusterName { get; init; }
@@ -60,7 +60,7 @@ public sealed partial class ClusterStatsResponse : ElasticsearchResponse
6060
public Elastic.Clients.Elasticsearch.HealthStatus Status { get; init; }
6161

6262
/// <summary>
63-
/// <para>Unix timestamp, in milliseconds, of the last time the cluster statistics were refreshed.</para>
63+
/// <para>Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.</para>
6464
/// </summary>
6565
[JsonInclude, JsonPropertyName("timestamp")]
6666
public long Timestamp { get; init; }

src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/GetClusterSettingsRequest.g.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,28 +32,28 @@ namespace Elastic.Clients.Elasticsearch.Cluster;
3232
public sealed class GetClusterSettingsRequestParameters : RequestParameters
3333
{
3434
/// <summary>
35-
/// <para>Return settings in flat format (default: false)</para>
35+
/// <para>If `true`, returns settings in flat format.</para>
3636
/// </summary>
3737
public bool? FlatSettings { get => Q<bool?>("flat_settings"); set => Q("flat_settings", value); }
3838

3939
/// <summary>
40-
/// <para>Whether to return all default clusters setting.</para>
40+
/// <para>If `true`, returns default cluster settings from the local node.</para>
4141
/// </summary>
4242
public bool? IncludeDefaults { get => Q<bool?>("include_defaults"); set => Q("include_defaults", value); }
4343

4444
/// <summary>
45-
/// <para>Explicit operation timeout for connection to master node</para>
45+
/// <para>Period to wait for a connection to the master node.<br/>If no response is received before the timeout expires, the request fails and returns an error.</para>
4646
/// </summary>
4747
public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("master_timeout"); set => Q("master_timeout", value); }
4848

4949
/// <summary>
50-
/// <para>Explicit operation timeout</para>
50+
/// <para>Period to wait for a response.<br/>If no response is received before the timeout expires, the request fails and returns an error.</para>
5151
/// </summary>
5252
public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("timeout"); set => Q("timeout", value); }
5353
}
5454

5555
/// <summary>
56-
/// <para>Returns cluster settings.</para>
56+
/// <para>Returns cluster-wide settings.<br/>By default, it returns only settings that have been explicitly defined.</para>
5757
/// </summary>
5858
public sealed partial class GetClusterSettingsRequest : PlainRequest<GetClusterSettingsRequestParameters>
5959
{
@@ -64,32 +64,32 @@ public sealed partial class GetClusterSettingsRequest : PlainRequest<GetClusterS
6464
internal override bool SupportsBody => false;
6565

6666
/// <summary>
67-
/// <para>Return settings in flat format (default: false)</para>
67+
/// <para>If `true`, returns settings in flat format.</para>
6868
/// </summary>
6969
[JsonIgnore]
7070
public bool? FlatSettings { get => Q<bool?>("flat_settings"); set => Q("flat_settings", value); }
7171

7272
/// <summary>
73-
/// <para>Whether to return all default clusters setting.</para>
73+
/// <para>If `true`, returns default cluster settings from the local node.</para>
7474
/// </summary>
7575
[JsonIgnore]
7676
public bool? IncludeDefaults { get => Q<bool?>("include_defaults"); set => Q("include_defaults", value); }
7777

7878
/// <summary>
79-
/// <para>Explicit operation timeout for connection to master node</para>
79+
/// <para>Period to wait for a connection to the master node.<br/>If no response is received before the timeout expires, the request fails and returns an error.</para>
8080
/// </summary>
8181
[JsonIgnore]
8282
public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("master_timeout"); set => Q("master_timeout", value); }
8383

8484
/// <summary>
85-
/// <para>Explicit operation timeout</para>
85+
/// <para>Period to wait for a response.<br/>If no response is received before the timeout expires, the request fails and returns an error.</para>
8686
/// </summary>
8787
[JsonIgnore]
8888
public Elastic.Clients.Elasticsearch.Duration? Timeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("timeout"); set => Q("timeout", value); }
8989
}
9090

9191
/// <summary>
92-
/// <para>Returns cluster settings.</para>
92+
/// <para>Returns cluster-wide settings.<br/>By default, it returns only settings that have been explicitly defined.</para>
9393
/// </summary>
9494
public sealed partial class GetClusterSettingsRequestDescriptor : RequestDescriptor<GetClusterSettingsRequestDescriptor, GetClusterSettingsRequestParameters>
9595
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/Cluster/PendingTasksRequest.g.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ namespace Elastic.Clients.Elasticsearch.Cluster;
3232
public sealed class PendingTasksRequestParameters : RequestParameters
3333
{
3434
/// <summary>
35-
/// <para>Return local information, do not retrieve the state from master node (default: false)</para>
35+
/// <para>If `true`, the request retrieves information from the local node only.<br/>If `false`, information is retrieved from the master node.</para>
3636
/// </summary>
3737
public bool? Local { get => Q<bool?>("local"); set => Q("local", value); }
3838

3939
/// <summary>
40-
/// <para>Specify timeout for connection to master</para>
40+
/// <para>Period to wait for a connection to the master node.<br/>If no response is received before the timeout expires, the request fails and returns an error.</para>
4141
/// </summary>
4242
public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("master_timeout"); set => Q("master_timeout", value); }
4343
}
4444

4545
/// <summary>
46-
/// <para>Returns a list of any cluster-level changes (e.g. create index, update mapping,<br/>allocate or fail shard) which have not yet been executed.</para>
46+
/// <para>Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.<br/>NOTE: This API returns a list of any pending updates to the cluster state.<br/>These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.<br/>However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.</para>
4747
/// </summary>
4848
public sealed partial class PendingTasksRequest : PlainRequest<PendingTasksRequestParameters>
4949
{
@@ -54,20 +54,20 @@ public sealed partial class PendingTasksRequest : PlainRequest<PendingTasksReque
5454
internal override bool SupportsBody => false;
5555

5656
/// <summary>
57-
/// <para>Return local information, do not retrieve the state from master node (default: false)</para>
57+
/// <para>If `true`, the request retrieves information from the local node only.<br/>If `false`, information is retrieved from the master node.</para>
5858
/// </summary>
5959
[JsonIgnore]
6060
public bool? Local { get => Q<bool?>("local"); set => Q("local", value); }
6161

6262
/// <summary>
63-
/// <para>Specify timeout for connection to master</para>
63+
/// <para>Period to wait for a connection to the master node.<br/>If no response is received before the timeout expires, the request fails and returns an error.</para>
6464
/// </summary>
6565
[JsonIgnore]
6666
public Elastic.Clients.Elasticsearch.Duration? MasterTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("master_timeout"); set => Q("master_timeout", value); }
6767
}
6868

6969
/// <summary>
70-
/// <para>Returns a list of any cluster-level changes (e.g. create index, update mapping,<br/>allocate or fail shard) which have not yet been executed.</para>
70+
/// <para>Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.<br/>NOTE: This API returns a list of any pending updates to the cluster state.<br/>These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests.<br/>However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.</para>
7171
/// </summary>
7272
public sealed partial class PendingTasksRequestDescriptor : RequestDescriptor<PendingTasksRequestDescriptor, PendingTasksRequestParameters>
7373
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsRequest.g.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public sealed class EnrichStatsRequestParameters : RequestParameters
3434
}
3535

3636
/// <summary>
37-
/// <para>Gets enrich coordinator statistics and information about enrich policies that are currently executing.</para>
37+
/// <para>Returns enrich coordinator statistics and information about enrich policies that are currently executing.</para>
3838
/// </summary>
3939
public sealed partial class EnrichStatsRequest : PlainRequest<EnrichStatsRequestParameters>
4040
{
@@ -46,7 +46,7 @@ public sealed partial class EnrichStatsRequest : PlainRequest<EnrichStatsRequest
4646
}
4747

4848
/// <summary>
49-
/// <para>Gets enrich coordinator statistics and information about enrich policies that are currently executing.</para>
49+
/// <para>Returns enrich coordinator statistics and information about enrich policies that are currently executing.</para>
5050
/// </summary>
5151
public sealed partial class EnrichStatsRequestDescriptor : RequestDescriptor<EnrichStatsRequestDescriptor, EnrichStatsRequestParameters>
5252
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/EnrichStatsResponse.g.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,21 @@ namespace Elastic.Clients.Elasticsearch.Enrich;
2727

2828
public sealed partial class EnrichStatsResponse : ElasticsearchResponse
2929
{
30+
/// <summary>
31+
/// <para>Objects containing information about the enrich cache stats on each ingest node.</para>
32+
/// </summary>
3033
[JsonInclude, JsonPropertyName("cache_stats")]
3134
public IReadOnlyCollection<Elastic.Clients.Elasticsearch.Enrich.CacheStats>? CacheStats { get; init; }
35+
36+
/// <summary>
37+
/// <para>Objects containing information about each coordinating ingest node for configured enrich processors.</para>
38+
/// </summary>
3239
[JsonInclude, JsonPropertyName("coordinator_stats")]
3340
public IReadOnlyCollection<Elastic.Clients.Elasticsearch.Enrich.CoordinatorStats> CoordinatorStats { get; init; }
41+
42+
/// <summary>
43+
/// <para>Objects containing information about each enrich policy that is currently executing.</para>
44+
/// </summary>
3445
[JsonInclude, JsonPropertyName("executing_policies")]
3546
public IReadOnlyCollection<Elastic.Clients.Elasticsearch.Enrich.ExecutingPolicy> ExecutingPolicies { get; init; }
3647
}

src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/ExecutePolicyRequest.g.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace Elastic.Clients.Elasticsearch.Enrich;
3232
public sealed class ExecutePolicyRequestParameters : RequestParameters
3333
{
3434
/// <summary>
35-
/// <para>Should the request should block until the execution is complete.</para>
35+
/// <para>If `true`, the request blocks other enrich policy execution requests until complete.</para>
3636
/// </summary>
3737
public bool? WaitForCompletion { get => Q<bool?>("wait_for_completion"); set => Q("wait_for_completion", value); }
3838
}
@@ -53,7 +53,7 @@ public ExecutePolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r =>
5353
internal override bool SupportsBody => false;
5454

5555
/// <summary>
56-
/// <para>Should the request should block until the execution is complete.</para>
56+
/// <para>If `true`, the request blocks other enrich policy execution requests until complete.</para>
5757
/// </summary>
5858
[JsonIgnore]
5959
public bool? WaitForCompletion { get => Q<bool?>("wait_for_completion"); set => Q("wait_for_completion", value); }

src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/GetPolicyRequest.g.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public sealed class GetPolicyRequestParameters : RequestParameters
3434
}
3535

3636
/// <summary>
37-
/// <para>Gets information about an enrich policy.</para>
37+
/// <para>Returns information about an enrich policy.</para>
3838
/// </summary>
3939
public sealed partial class GetPolicyRequest : PlainRequest<GetPolicyRequestParameters>
4040
{
@@ -54,7 +54,7 @@ public GetPolicyRequest(Elastic.Clients.Elasticsearch.Names? name) : base(r => r
5454
}
5555

5656
/// <summary>
57-
/// <para>Gets information about an enrich policy.</para>
57+
/// <para>Returns information about an enrich policy.</para>
5858
/// </summary>
5959
public sealed partial class GetPolicyRequestDescriptor : RequestDescriptor<GetPolicyRequestDescriptor, GetPolicyRequestParameters>
6060
{

src/Elastic.Clients.Elasticsearch/_Generated/Api/Enrich/PutPolicyRequest.g.cs

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public sealed class PutPolicyRequestParameters : RequestParameters
3434
}
3535

3636
/// <summary>
37-
/// <para>Creates a new enrich policy.</para>
37+
/// <para>Creates an enrich policy.</para>
3838
/// </summary>
3939
public sealed partial class PutPolicyRequest : PlainRequest<PutPolicyRequestParameters>
4040
{
@@ -48,16 +48,27 @@ public PutPolicyRequest(Elastic.Clients.Elasticsearch.Name name) : base(r => r.R
4848

4949
internal override bool SupportsBody => true;
5050

51+
/// <summary>
52+
/// <para>Matches enrich data to incoming documents based on a `geo_shape` query.</para>
53+
/// </summary>
5154
[JsonInclude, JsonPropertyName("geo_match")]
5255
public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? GeoMatch { get; set; }
56+
57+
/// <summary>
58+
/// <para>Matches enrich data to incoming documents based on a `term` query.</para>
59+
/// </summary>
5360
[JsonInclude, JsonPropertyName("match")]
5461
public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? Match { get; set; }
62+
63+
/// <summary>
64+
/// <para>Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.</para>
65+
/// </summary>
5566
[JsonInclude, JsonPropertyName("range")]
5667
public Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? Range { get; set; }
5768
}
5869

5970
/// <summary>
60-
/// <para>Creates a new enrich policy.</para>
71+
/// <para>Creates an enrich policy.</para>
6172
/// </summary>
6273
public sealed partial class PutPolicyRequestDescriptor<TDocument> : RequestDescriptor<PutPolicyRequestDescriptor<TDocument>, PutPolicyRequestParameters>
6374
{
@@ -93,6 +104,9 @@ public PutPolicyRequestDescriptor<TDocument> Name(Elastic.Clients.Elasticsearch.
93104
private EnrichPolicyDescriptor<TDocument> RangeDescriptor { get; set; }
94105
private Action<EnrichPolicyDescriptor<TDocument>> RangeDescriptorAction { get; set; }
95106

107+
/// <summary>
108+
/// <para>Matches enrich data to incoming documents based on a `geo_shape` query.</para>
109+
/// </summary>
96110
public PutPolicyRequestDescriptor<TDocument> GeoMatch(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? geoMatch)
97111
{
98112
GeoMatchDescriptor = null;
@@ -117,6 +131,9 @@ public PutPolicyRequestDescriptor<TDocument> GeoMatch(Action<EnrichPolicyDescrip
117131
return Self;
118132
}
119133

134+
/// <summary>
135+
/// <para>Matches enrich data to incoming documents based on a `term` query.</para>
136+
/// </summary>
120137
public PutPolicyRequestDescriptor<TDocument> Match(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? match)
121138
{
122139
MatchDescriptor = null;
@@ -141,6 +158,9 @@ public PutPolicyRequestDescriptor<TDocument> Match(Action<EnrichPolicyDescriptor
141158
return Self;
142159
}
143160

161+
/// <summary>
162+
/// <para>Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.</para>
163+
/// </summary>
144164
public PutPolicyRequestDescriptor<TDocument> Range(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? range)
145165
{
146166
RangeDescriptor = null;
@@ -221,7 +241,7 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
221241
}
222242

223243
/// <summary>
224-
/// <para>Creates a new enrich policy.</para>
244+
/// <para>Creates an enrich policy.</para>
225245
/// </summary>
226246
public sealed partial class PutPolicyRequestDescriptor : RequestDescriptor<PutPolicyRequestDescriptor, PutPolicyRequestParameters>
227247
{
@@ -257,6 +277,9 @@ public PutPolicyRequestDescriptor Name(Elastic.Clients.Elasticsearch.Name name)
257277
private EnrichPolicyDescriptor RangeDescriptor { get; set; }
258278
private Action<EnrichPolicyDescriptor> RangeDescriptorAction { get; set; }
259279

280+
/// <summary>
281+
/// <para>Matches enrich data to incoming documents based on a `geo_shape` query.</para>
282+
/// </summary>
260283
public PutPolicyRequestDescriptor GeoMatch(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? geoMatch)
261284
{
262285
GeoMatchDescriptor = null;
@@ -281,6 +304,9 @@ public PutPolicyRequestDescriptor GeoMatch(Action<EnrichPolicyDescriptor> config
281304
return Self;
282305
}
283306

307+
/// <summary>
308+
/// <para>Matches enrich data to incoming documents based on a `term` query.</para>
309+
/// </summary>
284310
public PutPolicyRequestDescriptor Match(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? match)
285311
{
286312
MatchDescriptor = null;
@@ -305,6 +331,9 @@ public PutPolicyRequestDescriptor Match(Action<EnrichPolicyDescriptor> configure
305331
return Self;
306332
}
307333

334+
/// <summary>
335+
/// <para>Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.</para>
336+
/// </summary>
308337
public PutPolicyRequestDescriptor Range(Elastic.Clients.Elasticsearch.Enrich.EnrichPolicy? range)
309338
{
310339
RangeDescriptor = null;

0 commit comments

Comments
 (0)