Skip to content

Commit e5cbae4

Browse files
l-trottal-trotta
committed
[codegen] update to latest spec
1 parent ef157c3 commit e5cbae4

File tree

230 files changed

+20498
-1718
lines changed

Some content is hidden

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

230 files changed

+20498
-1718
lines changed

‎java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchAsyncClient.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1315,10 +1315,10 @@ public final <TDocument> CompletableFuture<IndexResponse> index(
13151315
// ----- Endpoint: info
13161316

13171317
/**
1318-
* Get cluster info. Returns basic information about the cluster.
1318+
* Get cluster info. Get basic build, version, and cluster information.
13191319
*
13201320
* @see <a href=
1321-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation
1321+
* "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rest-api-root.html">Documentation
13221322
* on elastic.co</a>
13231323
*/
13241324
public CompletableFuture<InfoResponse> info() {

‎java-client/src/main/java/co/elastic/clients/elasticsearch/ElasticsearchClient.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1334,10 +1334,10 @@ public final <TDocument> IndexResponse index(
13341334
// ----- Endpoint: info
13351335

13361336
/**
1337-
* Get cluster info. Returns basic information about the cluster.
1337+
* Get cluster info. Get basic build, version, and cluster information.
13381338
*
13391339
* @see <a href=
1340-
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation
1340+
* "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/rest-api-root.html">Documentation
13411341
* on elastic.co</a>
13421342
*/
13431343
public InfoResponse info() throws IOException, ElasticsearchException {

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

Lines changed: 64 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -102,63 +102,86 @@ public static ElasticsearchVersionInfo of(Function<Builder, ObjectBuilder<Elasti
102102
}
103103

104104
/**
105-
* Required - API name: {@code build_date}
105+
* Required - The Elasticsearch Git commit's date.
106+
* <p>
107+
* API name: {@code build_date}
106108
*/
107109
public final DateTime buildDate() {
108110
return this.buildDate;
109111
}
110112

111113
/**
112-
* Required - API name: {@code build_flavor}
114+
* Required - The build flavor. For example, <code>default</code>.
115+
* <p>
116+
* API name: {@code build_flavor}
113117
*/
114118
public final String buildFlavor() {
115119
return this.buildFlavor;
116120
}
117121

118122
/**
119-
* Required - API name: {@code build_hash}
123+
* Required - The Elasticsearch Git commit's SHA hash.
124+
* <p>
125+
* API name: {@code build_hash}
120126
*/
121127
public final String buildHash() {
122128
return this.buildHash;
123129
}
124130

125131
/**
126-
* Required - API name: {@code build_snapshot}
132+
* Required - Indicates whether the Elasticsearch build was a snapshot.
133+
* <p>
134+
* API name: {@code build_snapshot}
127135
*/
128136
public final boolean buildSnapshot() {
129137
return this.buildSnapshot;
130138
}
131139

132140
/**
133-
* Required - API name: {@code build_type}
141+
* Required - The build type that corresponds to how Elasticsearch was
142+
* installed. For example, <code>docker</code>, <code>rpm</code>, or
143+
* <code>tar</code>.
144+
* <p>
145+
* API name: {@code build_type}
134146
*/
135147
public final String buildType() {
136148
return this.buildType;
137149
}
138150

139151
/**
140-
* Required - API name: {@code lucene_version}
152+
* Required - The version number of Elasticsearch's underlying Lucene software.
153+
* <p>
154+
* API name: {@code lucene_version}
141155
*/
142156
public final String luceneVersion() {
143157
return this.luceneVersion;
144158
}
145159

146160
/**
147-
* Required - API name: {@code minimum_index_compatibility_version}
161+
* Required - The minimum index version with which the responding node can read
162+
* from disk.
163+
* <p>
164+
* API name: {@code minimum_index_compatibility_version}
148165
*/
149166
public final String minimumIndexCompatibilityVersion() {
150167
return this.minimumIndexCompatibilityVersion;
151168
}
152169

153170
/**
154-
* Required - API name: {@code minimum_wire_compatibility_version}
171+
* Required - The minimum node version with which the responding node can
172+
* communicate. Also the minimum version from which you can perform a rolling
173+
* upgrade.
174+
* <p>
175+
* API name: {@code minimum_wire_compatibility_version}
155176
*/
156177
public final String minimumWireCompatibilityVersion() {
157178
return this.minimumWireCompatibilityVersion;
158179
}
159180

160181
/**
161-
* Required - API name: {@code number}
182+
* Required - The Elasticsearch version number.
183+
* <p>
184+
* API name: {@code number}
162185
*/
163186
public final String number() {
164187
return this.number;
@@ -236,71 +259,94 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder>
236259
private String number;
237260

238261
/**
239-
* Required - API name: {@code build_date}
262+
* Required - The Elasticsearch Git commit's date.
263+
* <p>
264+
* API name: {@code build_date}
240265
*/
241266
public final Builder buildDate(DateTime value) {
242267
this.buildDate = value;
243268
return this;
244269
}
245270

246271
/**
247-
* Required - API name: {@code build_flavor}
272+
* Required - The build flavor. For example, <code>default</code>.
273+
* <p>
274+
* API name: {@code build_flavor}
248275
*/
249276
public final Builder buildFlavor(String value) {
250277
this.buildFlavor = value;
251278
return this;
252279
}
253280

254281
/**
255-
* Required - API name: {@code build_hash}
282+
* Required - The Elasticsearch Git commit's SHA hash.
283+
* <p>
284+
* API name: {@code build_hash}
256285
*/
257286
public final Builder buildHash(String value) {
258287
this.buildHash = value;
259288
return this;
260289
}
261290

262291
/**
263-
* Required - API name: {@code build_snapshot}
292+
* Required - Indicates whether the Elasticsearch build was a snapshot.
293+
* <p>
294+
* API name: {@code build_snapshot}
264295
*/
265296
public final Builder buildSnapshot(boolean value) {
266297
this.buildSnapshot = value;
267298
return this;
268299
}
269300

270301
/**
271-
* Required - API name: {@code build_type}
302+
* Required - The build type that corresponds to how Elasticsearch was
303+
* installed. For example, <code>docker</code>, <code>rpm</code>, or
304+
* <code>tar</code>.
305+
* <p>
306+
* API name: {@code build_type}
272307
*/
273308
public final Builder buildType(String value) {
274309
this.buildType = value;
275310
return this;
276311
}
277312

278313
/**
279-
* Required - API name: {@code lucene_version}
314+
* Required - The version number of Elasticsearch's underlying Lucene software.
315+
* <p>
316+
* API name: {@code lucene_version}
280317
*/
281318
public final Builder luceneVersion(String value) {
282319
this.luceneVersion = value;
283320
return this;
284321
}
285322

286323
/**
287-
* Required - API name: {@code minimum_index_compatibility_version}
324+
* Required - The minimum index version with which the responding node can read
325+
* from disk.
326+
* <p>
327+
* API name: {@code minimum_index_compatibility_version}
288328
*/
289329
public final Builder minimumIndexCompatibilityVersion(String value) {
290330
this.minimumIndexCompatibilityVersion = value;
291331
return this;
292332
}
293333

294334
/**
295-
* Required - API name: {@code minimum_wire_compatibility_version}
335+
* Required - The minimum node version with which the responding node can
336+
* communicate. Also the minimum version from which you can perform a rolling
337+
* upgrade.
338+
* <p>
339+
* API name: {@code minimum_wire_compatibility_version}
296340
*/
297341
public final Builder minimumWireCompatibilityVersion(String value) {
298342
this.minimumWireCompatibilityVersion = value;
299343
return this;
300344
}
301345

302346
/**
303-
* Required - API name: {@code number}
347+
* Required - The Elasticsearch version number.
348+
* <p>
349+
* API name: {@code number}
304350
*/
305351
public final Builder number(String value) {
306352
this.number = value;

‎java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/DeleteComponentTemplateRequest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@
5858
// typedef: cluster.delete_component_template.Request
5959

6060
/**
61-
* Delete component templates. Deletes component templates. Component templates
62-
* are building blocks for constructing index templates that specify index
63-
* mappings, settings, and aliases.
61+
* Delete component templates. Component templates are building blocks for
62+
* constructing index templates that specify index mappings, settings, and
63+
* aliases.
6464
*
6565
* @see <a href=
6666
* "../doc-files/api-spec.html#cluster.delete_component_template.Request">API

‎java-client/src/main/java/co/elastic/clients/elasticsearch/cluster/ElasticsearchClusterAsyncClient.java

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,9 @@ public CompletableFuture<AllocationExplainResponse> allocationExplain() {
135135
// ----- Endpoint: cluster.delete_component_template
136136

137137
/**
138-
* Delete component templates. Deletes component templates. Component templates
139-
* are building blocks for constructing index templates that specify index
140-
* mappings, settings, and aliases.
138+
* Delete component templates. Component templates are building blocks for
139+
* constructing index templates that specify index mappings, settings, and
140+
* aliases.
141141
*
142142
* @see <a href=
143143
* "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation
@@ -153,9 +153,9 @@ public CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplat
153153
}
154154

155155
/**
156-
* Delete component templates. Deletes component templates. Component templates
157-
* are building blocks for constructing index templates that specify index
158-
* mappings, settings, and aliases.
156+
* Delete component templates. Component templates are building blocks for
157+
* constructing index templates that specify index mappings, settings, and
158+
* aliases.
159159
*
160160
* @param fn
161161
* a function that initializes a builder to create the
@@ -258,7 +258,7 @@ public final CompletableFuture<BooleanResponse> existsComponentTemplate(
258258
// ----- Endpoint: cluster.get_component_template
259259

260260
/**
261-
* Get component templates. Retrieves information about component templates.
261+
* Get component templates. Get information about component templates.
262262
*
263263
* @see <a href=
264264
* "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation
@@ -273,7 +273,7 @@ public CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(GetC
273273
}
274274

275275
/**
276-
* Get component templates. Retrieves information about component templates.
276+
* Get component templates. Get information about component templates.
277277
*
278278
* @param fn
279279
* a function that initializes a builder to create the
@@ -289,7 +289,7 @@ public final CompletableFuture<GetComponentTemplateResponse> getComponentTemplat
289289
}
290290

291291
/**
292-
* Get component templates. Retrieves information about component templates.
292+
* Get component templates. Get information about component templates.
293293
*
294294
* @see <a href=
295295
* "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation
@@ -692,9 +692,9 @@ public CompletableFuture<BooleanResponse> postVotingConfigExclusions() {
692692
// ----- Endpoint: cluster.put_component_template
693693

694694
/**
695-
* Create or update a component template. Creates or updates a component
696-
* template. Component templates are building blocks for constructing index
697-
* templates that specify index mappings, settings, and aliases.
695+
* Create or update a component template. Component templates are building
696+
* blocks for constructing index templates that specify index mappings,
697+
* settings, and aliases.
698698
* <p>
699699
* An index template can be composed of multiple component templates. To use a
700700
* component template, specify it in an index template’s
@@ -713,6 +713,12 @@ public CompletableFuture<BooleanResponse> postVotingConfigExclusions() {
713713
* You can use C-style <code>/* *\/</code> block comments in component
714714
* templates. You can include comments anywhere in the request body except
715715
* before the opening curly bracket.
716+
* <p>
717+
* <strong>Applying component templates</strong>
718+
* <p>
719+
* You cannot directly apply a component template to a data stream or index. To
720+
* be applied, a component template must be included in an index template's
721+
* <code>composed_of</code> list.
716722
*
717723
* @see <a href=
718724
* "https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-component-template.html">Documentation
@@ -727,9 +733,9 @@ public CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutC
727733
}
728734

729735
/**
730-
* Create or update a component template. Creates or updates a component
731-
* template. Component templates are building blocks for constructing index
732-
* templates that specify index mappings, settings, and aliases.
736+
* Create or update a component template. Component templates are building
737+
* blocks for constructing index templates that specify index mappings,
738+
* settings, and aliases.
733739
* <p>
734740
* An index template can be composed of multiple component templates. To use a
735741
* component template, specify it in an index template’s
@@ -748,6 +754,12 @@ public CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutC
748754
* You can use C-style <code>/* *\/</code> block comments in component
749755
* templates. You can include comments anywhere in the request body except
750756
* before the opening curly bracket.
757+
* <p>
758+
* <strong>Applying component templates</strong>
759+
* <p>
760+
* You cannot directly apply a component template to a data stream or index. To
761+
* be applied, a component template must be included in an index template's
762+
* <code>composed_of</code> list.
751763
*
752764
* @param fn
753765
* a function that initializes a builder to create the

0 commit comments

Comments
 (0)