Skip to content

Commit 2f3ac74

Browse files
committed
Add XML doc comments for enums
1 parent 6a3088c commit 2f3ac74

File tree

7 files changed

+85
-0
lines changed

7 files changed

+85
-0
lines changed

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Aggregations.g.cs

+9
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,19 @@ public override void Write(Utf8JsonWriter writer, CardinalityExecutionMode value
182182
[JsonConverter(typeof(GapPolicyConverter))]
183183
public enum GapPolicy
184184
{
185+
/// <summary>
186+
/// <para>Treats missing data as if the bucket does not exist. It will skip the bucket and<br/>continue calculating using the next available value.</para>
187+
/// </summary>
185188
[EnumMember(Value = "skip")]
186189
Skip,
190+
/// <summary>
191+
/// <para>Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,<br/>otherwise the empty bucket is skipped.</para>
192+
/// </summary>
187193
[EnumMember(Value = "keep_values")]
188194
KeepValues,
195+
/// <summary>
196+
/// <para>Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.</para>
197+
/// </summary>
189198
[EnumMember(Value = "insert_zeros")]
190199
InsertZeros
191200
}

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Core.Search.g.cs

+6
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,14 @@ public override void Write(Utf8JsonWriter writer, SuggestSort value, JsonSeriali
415415
[JsonConverter(typeof(TotalHitsRelationConverter))]
416416
public enum TotalHitsRelation
417417
{
418+
/// <summary>
419+
/// <para>Lower bound, including returned events or sequences</para>
420+
/// </summary>
418421
[EnumMember(Value = "gte")]
419422
Gte,
423+
/// <summary>
424+
/// <para>Accurate</para>
425+
/// </summary>
420426
[EnumMember(Value = "eq")]
421427
Eq
422428
}

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Eql.g.cs

+6
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,14 @@ namespace Elastic.Clients.Elasticsearch.Eql;
2929
[JsonConverter(typeof(ResultPositionConverter))]
3030
public enum ResultPosition
3131
{
32+
/// <summary>
33+
/// <para>Return the most recent matches, similar to the Unix tail command.</para>
34+
/// </summary>
3235
[EnumMember(Value = "tail")]
3336
Tail,
37+
/// <summary>
38+
/// <para>Return the earliest matches, similar to the Unix head command.</para>
39+
/// </summary>
3440
[EnumMember(Value = "head")]
3541
Head
3642
}

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.IndexManagement.g.cs

+22
Original file line numberDiff line numberDiff line change
@@ -502,9 +502,25 @@ public readonly partial struct StorageType
502502
public StorageType(string value) => Value = value;
503503

504504
public readonly string Value { get; }
505+
506+
/// <summary>
507+
/// <para>The NIO FS type stores the shard index on the file system (maps to Lucene NIOFSDirectory) using NIO. It allows multiple<br/>threads to read from the same file concurrently. It is not recommended on Windows because of a bug in the SUN Java<br/>implementation and disables some optimizations for heap memory usage.</para>
508+
/// </summary>
505509
public static StorageType Niofs { get; } = new StorageType("niofs");
510+
511+
/// <summary>
512+
/// <para>The MMap FS type stores the shard index on the file system (maps to Lucene MMapDirectory) by mapping a file into<br/>memory (mmap). Memory mapping uses up a portion of the virtual memory address space in your process equal to the size<br/>of the file being mapped. Before using this class, be sure you have allowed plenty of virtual address space.</para>
513+
/// </summary>
506514
public static StorageType Mmapfs { get; } = new StorageType("mmapfs");
515+
516+
/// <summary>
517+
/// <para>The hybridfs type is a hybrid of niofs and mmapfs, which chooses the best file system type for each type of file<br/>based on the read access pattern. Currently only the Lucene term dictionary, norms and doc values files are memory<br/>mapped. All other files are opened using Lucene NIOFSDirectory. Similarly to mmapfs be sure you have allowed<br/>plenty of virtual address space.</para>
518+
/// </summary>
507519
public static StorageType Hybridfs { get; } = new StorageType("hybridfs");
520+
521+
/// <summary>
522+
/// <para>Default file system implementation. This will pick the best implementation depending on the operating environment, which<br/>is currently hybridfs on all supported systems but is subject to change.</para>
523+
/// </summary>
508524
public static StorageType Fs { get; } = new StorageType("fs");
509525

510526
public override string ToString() => Value ?? string.Empty;
@@ -523,8 +539,14 @@ public readonly partial struct StorageType
523539
[JsonConverter(typeof(TranslogDurabilityConverter))]
524540
public enum TranslogDurability
525541
{
542+
/// <summary>
543+
/// <para>(default) fsync and commit after every request. In the event of hardware failure, all acknowledged writes<br/>will already have been committed to disk.</para>
544+
/// </summary>
526545
[EnumMember(Value = "request")]
527546
Request,
547+
/// <summary>
548+
/// <para>fsync and commit in the background every sync_interval. In the event of a failure, all acknowledged writes<br/>since the last automatic commit will be discarded.</para>
549+
/// </summary>
528550
[EnumMember(Value = "async")]
529551
Async
530552
}

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Ingest.g.cs

+6
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,14 @@ public override void Write(Utf8JsonWriter writer, ConvertType value, JsonSeriali
105105
[JsonConverter(typeof(JsonProcessorConflictStrategyConverter))]
106106
public enum JsonProcessorConflictStrategy
107107
{
108+
/// <summary>
109+
/// <para>Root fields that conflict with fields from the parsed JSON will be overridden.</para>
110+
/// </summary>
108111
[EnumMember(Value = "replace")]
109112
Replace,
113+
/// <summary>
114+
/// <para>Conflicting fields will be merged.</para>
115+
/// </summary>
110116
[EnumMember(Value = "merge")]
111117
Merge
112118
}

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.Mapping.g.cs

+3
Original file line numberDiff line numberDiff line change
@@ -706,6 +706,9 @@ public override void Write(Utf8JsonWriter writer, RuntimeFieldType value, JsonSe
706706
[JsonConverter(typeof(SourceFieldModeConverter))]
707707
public enum SourceFieldMode
708708
{
709+
/// <summary>
710+
/// <para>Instead of storing source documents on disk exactly as you send them,<br/> Elasticsearch can reconstruct source content on the fly upon retrieval.</para>
711+
/// </summary>
709712
[EnumMember(Value = "synthetic")]
710713
Synthetic,
711714
[EnumMember(Value = "stored")]

src/Elastic.Clients.Elasticsearch/_Generated/Types/Enums/Enums.NoNamespace.g.cs

+33
Original file line numberDiff line numberDiff line change
@@ -332,14 +332,29 @@ public override void Write(Utf8JsonWriter writer, DistanceUnit value, JsonSerial
332332
[JsonConverter(typeof(ExpandWildcardConverter))]
333333
public enum ExpandWildcard
334334
{
335+
/// <summary>
336+
/// <para>Match open, non-hidden indices. Also matches any non-hidden data stream.</para>
337+
/// </summary>
335338
[EnumMember(Value = "open")]
336339
Open,
340+
/// <summary>
341+
/// <para>Wildcard expressions are not accepted.</para>
342+
/// </summary>
337343
[EnumMember(Value = "none")]
338344
None,
345+
/// <summary>
346+
/// <para>Match hidden data streams and hidden indices. Must be combined with open, closed, or both.</para>
347+
/// </summary>
339348
[EnumMember(Value = "hidden")]
340349
Hidden,
350+
/// <summary>
351+
/// <para>Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.</para>
352+
/// </summary>
341353
[EnumMember(Value = "closed")]
342354
Closed,
355+
/// <summary>
356+
/// <para>Match any data stream or index, including hidden ones.</para>
357+
/// </summary>
343358
[EnumMember(Value = "all")]
344359
All
345360
}
@@ -545,10 +560,19 @@ public override void Write(Utf8JsonWriter writer, GeoShapeRelation value, JsonSe
545560
[JsonConverter(typeof(HealthStatusConverter))]
546561
public enum HealthStatus
547562
{
563+
/// <summary>
564+
/// <para>All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.</para>
565+
/// </summary>
548566
[EnumMember(Value = "yellow")]
549567
Yellow,
568+
/// <summary>
569+
/// <para>One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.</para>
570+
/// </summary>
550571
[EnumMember(Value = "red")]
551572
Red,
573+
/// <summary>
574+
/// <para>All shards are assigned.</para>
575+
/// </summary>
552576
[EnumMember(Value = "green")]
553577
Green
554578
}
@@ -1047,8 +1071,14 @@ public override void Write(Utf8JsonWriter writer, ScriptSortType value, JsonSeri
10471071
[JsonConverter(typeof(SearchTypeConverter))]
10481072
public enum SearchType
10491073
{
1074+
/// <summary>
1075+
/// <para>Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.</para>
1076+
/// </summary>
10501077
[EnumMember(Value = "query_then_fetch")]
10511078
QueryThenFetch,
1079+
/// <summary>
1080+
/// <para>Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.</para>
1081+
/// </summary>
10521082
[EnumMember(Value = "dfs_query_then_fetch")]
10531083
DfsQueryThenFetch
10541084
}
@@ -1088,6 +1118,9 @@ public override void Write(Utf8JsonWriter writer, SearchType value, JsonSerializ
10881118
[JsonConverter(typeof(SlicesCalculationConverter))]
10891119
public enum SlicesCalculation
10901120
{
1121+
/// <summary>
1122+
/// <para>Let Elasticsearch choose a reasonable number for most data streams and indices.</para>
1123+
/// </summary>
10911124
[EnumMember(Value = "auto")]
10921125
Auto
10931126
}

0 commit comments

Comments
 (0)