Skip to content

Commit ac9cccf

Browse files
[codegen] update to latest spec (#1206)
Co-authored-by: Laura Trotta <laura.trotta@elastic.co>
1 parent 6ee74b7 commit ac9cccf

29 files changed

+869
-218
lines changed

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/CommonStatsFlag.java

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,48 +45,123 @@
4545
*/
4646
@JsonpDeserializable
4747
public enum CommonStatsFlag implements JsonEnum {
48+
/**
49+
* Return all statistics.
50+
*/
4851
All("_all"),
4952

53+
/**
54+
* Size of the index in byte units.
55+
*/
5056
Store("store"),
5157

58+
/**
59+
* Indexing statistics.
60+
*/
5261
Indexing("indexing"),
5362

63+
/**
64+
* Get statistics, including missing stats.
65+
*/
5466
Get("get"),
5567

68+
/**
69+
* Search statistics including suggest statistics. You can include statistics
70+
* for custom groups by adding an extra <code>groups</code> parameter (search
71+
* operations can be associated with one or more groups). The
72+
* <code>groups</code> parameter accepts a comma-separated list of group names.
73+
* Use <code>_all</code> to return statistics for all groups.
74+
*/
5675
Search("search"),
5776

77+
/**
78+
* Merge statistics.
79+
*/
5880
Merge("merge"),
5981

82+
/**
83+
* Flush statistics.
84+
*/
6085
Flush("flush"),
6186

87+
/**
88+
* Refresh statistics.
89+
*/
6290
Refresh("refresh"),
6391

92+
/**
93+
* Query cache statistics.
94+
*/
6495
QueryCache("query_cache"),
6596

97+
/**
98+
* Fielddata statistics.
99+
*/
66100
Fielddata("fielddata"),
67101

102+
/**
103+
* Number of documents and deleted docs not yet merged out. Index refreshes can
104+
* affect this statistic.
105+
*/
68106
Docs("docs"),
69107

108+
/**
109+
* Index warming statistics.
110+
*/
70111
Warmer("warmer"),
71112

113+
/**
114+
* Completion suggester statistics.
115+
*/
72116
Completion("completion"),
73117

118+
/**
119+
* Memory use of all open segments. If the
120+
* <code>include_segment_file_sizes</code> parameter is <code>true</code>, this
121+
* metric includes the aggregated disk usage of each Lucene index file.
122+
*/
74123
Segments("segments"),
75124

125+
/**
126+
* Translog statistics.
127+
*/
76128
Translog("translog"),
77129

130+
/**
131+
* Shard request cache statistics.
132+
*/
78133
RequestCache("request_cache"),
79134

135+
/**
136+
* Recovery statistics.
137+
*/
80138
Recovery("recovery"),
81139

140+
/**
141+
* Bulk operations statistics.
142+
*/
82143
Bulk("bulk"),
83144

145+
/**
146+
* Shard statistics, including the total number of shards.
147+
*/
84148
ShardStats("shard_stats"),
85149

150+
/**
151+
* Mapping statistics, including the total count and estimated overhead.
152+
*/
86153
Mappings("mappings"),
87154

155+
/**
156+
* Total number of dense vectors indexed. Index refreshes can affect this
157+
* statistic.
158+
*/
88159
DenseVector("dense_vector"),
89160

161+
/**
162+
* Total number of sparse vectors indexed. Index refreshes can affect this
163+
* statistic.
164+
*/
90165
SparseVector("sparse_vector"),
91166

92167
;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/ThreadType.java

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,29 @@
4545
*/
4646
@JsonpDeserializable
4747
public enum ThreadType implements JsonEnum {
48+
/**
49+
* Threads that consume the most CPU time.
50+
*/
4851
Cpu("cpu"),
4952

53+
/**
54+
* Threads that have been in a waiting state the longest.
55+
*/
5056
Wait("wait"),
5157

58+
/**
59+
* Threads that have been blocked the longest.
60+
*/
5261
Block("block"),
5362

63+
/**
64+
* Threads that consume the most GPU time.
65+
*/
5466
Gpu("gpu"),
5567

68+
/**
69+
* Threads that allocate the most memory.
70+
*/
5671
Mem("mem"),
5772

5873
;

java-client/src/main/java/co/elastic/clients/elasticsearch/cat/CountRequest.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@
7070
* IMPORTANT: CAT APIs are only intended for human consumption using the command
7171
* line or Kibana console. They are not intended for use by applications. For
7272
* application consumption, use the count API.
73+
* <p>
74+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
75+
* <code>POST</code> method. This is primarily intended for project routing in
76+
* serverless environments.
7377
*
7478
* @see <a href="../doc-files/api-spec.html#cat.count.Request">API
7579
* specification</a>

java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatAsyncClient.java

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,10 @@ public CompletableFuture<ComponentTemplatesResponse> componentTemplates() {
278278
* IMPORTANT: CAT APIs are only intended for human consumption using the command
279279
* line or Kibana console. They are not intended for use by applications. For
280280
* application consumption, use the count API.
281+
* <p>
282+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
283+
* <code>POST</code> method. This is primarily intended for project routing in
284+
* serverless environments.
281285
*
282286
* @see <a href=
283287
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
@@ -301,6 +305,10 @@ public CompletableFuture<CountResponse> count(CountRequest request) {
301305
* IMPORTANT: CAT APIs are only intended for human consumption using the command
302306
* line or Kibana console. They are not intended for use by applications. For
303307
* application consumption, use the count API.
308+
* <p>
309+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
310+
* <code>POST</code> method. This is primarily intended for project routing in
311+
* serverless environments.
304312
*
305313
* @param fn
306314
* a function that initializes a builder to create the
@@ -325,6 +333,10 @@ public final CompletableFuture<CountResponse> count(
325333
* IMPORTANT: CAT APIs are only intended for human consumption using the command
326334
* line or Kibana console. They are not intended for use by applications. For
327335
* application consumption, use the count API.
336+
* <p>
337+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
338+
* <code>POST</code> method. This is primarily intended for project routing in
339+
* serverless environments.
328340
*
329341
* @see <a href=
330342
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
@@ -523,6 +535,17 @@ public CompletableFuture<TextResponse> help() {
523535
* include hidden nested documents. To get an accurate count of Elasticsearch
524536
* documents, use the cat count or count APIs.
525537
* <p>
538+
* NOTE: Storage metrics reported by this API reflect the post-compression size
539+
* of the indices on disk. Because these values are calculated after
540+
* Elasticsearch compresses the data and processes deletions, they are typically
541+
* significantly smaller than the raw, uncompressed data volume ingested.
542+
* <p>
543+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
544+
* uncompressed data volume, not the post-compression metrics reported here. To
545+
* learn more, refer to <a href=
546+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
547+
* billing dimensions</a>.
548+
* <p>
526549
* CAT APIs are only intended for human consumption using the command line or
527550
* Kibana console. They are not intended for use by applications. For
528551
* application consumption, use an index endpoint.
@@ -560,6 +583,17 @@ public CompletableFuture<IndicesResponse> indices(IndicesRequest request) {
560583
* include hidden nested documents. To get an accurate count of Elasticsearch
561584
* documents, use the cat count or count APIs.
562585
* <p>
586+
* NOTE: Storage metrics reported by this API reflect the post-compression size
587+
* of the indices on disk. Because these values are calculated after
588+
* Elasticsearch compresses the data and processes deletions, they are typically
589+
* significantly smaller than the raw, uncompressed data volume ingested.
590+
* <p>
591+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
592+
* uncompressed data volume, not the post-compression metrics reported here. To
593+
* learn more, refer to <a href=
594+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
595+
* billing dimensions</a>.
596+
* <p>
563597
* CAT APIs are only intended for human consumption using the command line or
564598
* Kibana console. They are not intended for use by applications. For
565599
* application consumption, use an index endpoint.
@@ -598,6 +632,17 @@ public final CompletableFuture<IndicesResponse> indices(
598632
* include hidden nested documents. To get an accurate count of Elasticsearch
599633
* documents, use the cat count or count APIs.
600634
* <p>
635+
* NOTE: Storage metrics reported by this API reflect the post-compression size
636+
* of the indices on disk. Because these values are calculated after
637+
* Elasticsearch compresses the data and processes deletions, they are typically
638+
* significantly smaller than the raw, uncompressed data volume ingested.
639+
* <p>
640+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
641+
* uncompressed data volume, not the post-compression metrics reported here. To
642+
* learn more, refer to <a href=
643+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
644+
* billing dimensions</a>.
645+
* <p>
601646
* CAT APIs are only intended for human consumption using the command line or
602647
* Kibana console. They are not intended for use by applications. For
603648
* application consumption, use an index endpoint.

java-client/src/main/java/co/elastic/clients/elasticsearch/cat/ElasticsearchCatClient.java

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,10 @@ public ComponentTemplatesResponse componentTemplates() throws IOException, Elast
281281
* IMPORTANT: CAT APIs are only intended for human consumption using the command
282282
* line or Kibana console. They are not intended for use by applications. For
283283
* application consumption, use the count API.
284+
* <p>
285+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
286+
* <code>POST</code> method. This is primarily intended for project routing in
287+
* serverless environments.
284288
*
285289
* @see <a href=
286290
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
@@ -304,6 +308,10 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear
304308
* IMPORTANT: CAT APIs are only intended for human consumption using the command
305309
* line or Kibana console. They are not intended for use by applications. For
306310
* application consumption, use the count API.
311+
* <p>
312+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
313+
* <code>POST</code> method. This is primarily intended for project routing in
314+
* serverless environments.
307315
*
308316
* @param fn
309317
* a function that initializes a builder to create the
@@ -328,6 +336,10 @@ public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<Co
328336
* IMPORTANT: CAT APIs are only intended for human consumption using the command
329337
* line or Kibana console. They are not intended for use by applications. For
330338
* application consumption, use the count API.
339+
* <p>
340+
* NOTE: Starting in Elasticsearch 9.3.0, this endpoint also supports the
341+
* <code>POST</code> method. This is primarily intended for project routing in
342+
* serverless environments.
331343
*
332344
* @see <a href=
333345
* "https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count">Documentation
@@ -526,6 +538,17 @@ public TextResponse help() throws IOException, ElasticsearchException {
526538
* include hidden nested documents. To get an accurate count of Elasticsearch
527539
* documents, use the cat count or count APIs.
528540
* <p>
541+
* NOTE: Storage metrics reported by this API reflect the post-compression size
542+
* of the indices on disk. Because these values are calculated after
543+
* Elasticsearch compresses the data and processes deletions, they are typically
544+
* significantly smaller than the raw, uncompressed data volume ingested.
545+
* <p>
546+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
547+
* uncompressed data volume, not the post-compression metrics reported here. To
548+
* learn more, refer to <a href=
549+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
550+
* billing dimensions</a>.
551+
* <p>
529552
* CAT APIs are only intended for human consumption using the command line or
530553
* Kibana console. They are not intended for use by applications. For
531554
* application consumption, use an index endpoint.
@@ -563,6 +586,17 @@ public IndicesResponse indices(IndicesRequest request) throws IOException, Elast
563586
* include hidden nested documents. To get an accurate count of Elasticsearch
564587
* documents, use the cat count or count APIs.
565588
* <p>
589+
* NOTE: Storage metrics reported by this API reflect the post-compression size
590+
* of the indices on disk. Because these values are calculated after
591+
* Elasticsearch compresses the data and processes deletions, they are typically
592+
* significantly smaller than the raw, uncompressed data volume ingested.
593+
* <p>
594+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
595+
* uncompressed data volume, not the post-compression metrics reported here. To
596+
* learn more, refer to <a href=
597+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
598+
* billing dimensions</a>.
599+
* <p>
566600
* CAT APIs are only intended for human consumption using the command line or
567601
* Kibana console. They are not intended for use by applications. For
568602
* application consumption, use an index endpoint.
@@ -601,6 +635,17 @@ public final IndicesResponse indices(Function<IndicesRequest.Builder, ObjectBuil
601635
* include hidden nested documents. To get an accurate count of Elasticsearch
602636
* documents, use the cat count or count APIs.
603637
* <p>
638+
* NOTE: Storage metrics reported by this API reflect the post-compression size
639+
* of the indices on disk. Because these values are calculated after
640+
* Elasticsearch compresses the data and processes deletions, they are typically
641+
* significantly smaller than the raw, uncompressed data volume ingested.
642+
* <p>
643+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
644+
* uncompressed data volume, not the post-compression metrics reported here. To
645+
* learn more, refer to <a href=
646+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
647+
* billing dimensions</a>.
648+
* <p>
604649
* CAT APIs are only intended for human consumption using the command line or
605650
* Kibana console. They are not intended for use by applications. For
606651
* application consumption, use an index endpoint.

java-client/src/main/java/co/elastic/clients/elasticsearch/cat/IndicesRequest.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,17 @@
8383
* include hidden nested documents. To get an accurate count of Elasticsearch
8484
* documents, use the cat count or count APIs.
8585
* <p>
86+
* NOTE: Storage metrics reported by this API reflect the post-compression size
87+
* of the indices on disk. Because these values are calculated after
88+
* Elasticsearch compresses the data and processes deletions, they are typically
89+
* significantly smaller than the raw, uncompressed data volume ingested.
90+
* <p>
91+
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
92+
* uncompressed data volume, not the post-compression metrics reported here. To
93+
* learn more, refer to <a href=
94+
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
95+
* billing dimensions</a>.
96+
* <p>
8697
* CAT APIs are only intended for human consumption using the command line or
8798
* Kibana console. They are not intended for use by applications. For
8899
* application consumption, use an index endpoint.

0 commit comments

Comments
 (0)