Skip to content

Commit 53d9d09

Browse files
[codegen] update to latest spec (#1130)
Co-authored-by: Laura Trotta <[email protected]>
1 parent 0f5f8b1 commit 53d9d09

File tree

12 files changed

+405
-170
lines changed

12 files changed

+405
-170
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ public final Time masterTimeout() {
150150
}
151151

152152
/**
153-
* Comma-separated list of component template names used to limit the request.
154-
* Wildcard (<code>*</code>) expressions are supported.
153+
* Name of component template to retrieve. Wildcard (<code>*</code>) expressions
154+
* are supported.
155155
* <p>
156156
* API name: {@code name}
157157
*/
@@ -254,8 +254,8 @@ public final Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> f
254254
}
255255

256256
/**
257-
* Comma-separated list of component template names used to limit the request.
258-
* Wildcard (<code>*</code>) expressions are supported.
257+
* Name of component template to retrieve. Wildcard (<code>*</code>) expressions
258+
* are supported.
259259
* <p>
260260
* API name: {@code name}
261261
*/

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

Lines changed: 62 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,7 @@ public static HealthRequest of(Function<Builder, ObjectBuilder<HealthRequest>> f
143143
}
144144

145145
/**
146-
* Whether to expand wildcard expression to concrete indices that are open,
147-
* closed or both.
146+
* Expand wildcard expression to concrete indices that are open, closed or both.
148147
* <p>
149148
* API name: {@code expand_wildcards}
150149
*/
@@ -153,10 +152,10 @@ public final List<ExpandWildcard> expandWildcards() {
153152
}
154153

155154
/**
156-
* Comma-separated list of data streams, indices, and index aliases used to
157-
* limit the request. Wildcard expressions (<code>*</code>) are supported. To
158-
* target all data streams and indices in a cluster, omit this parameter or use
159-
* _all or <code>*</code>.
155+
* A comma-separated list of data streams, indices, and index aliases that limit
156+
* the request. Wildcard expressions (<code>*</code>) are supported. To target
157+
* all data streams and indices in a cluster, omit this parameter or use _all or
158+
* <code>*</code>.
160159
* <p>
161160
* API name: {@code index}
162161
*/
@@ -165,8 +164,7 @@ public final List<String> index() {
165164
}
166165

167166
/**
168-
* Can be one of cluster, indices or shards. Controls the details level of the
169-
* health information returned.
167+
* Return health information at a specific level of detail.
170168
* <p>
171169
* API name: {@code level}
172170
*/
@@ -176,8 +174,8 @@ public final Level level() {
176174
}
177175

178176
/**
179-
* If true, the request retrieves information from the local node only. Defaults
180-
* to false, which means information is retrieved from the master node.
177+
* If true, retrieve information from the local node only. If false, retrieve
178+
* information from the master node.
181179
* <p>
182180
* API name: {@code local}
183181
*/
@@ -187,7 +185,7 @@ public final Boolean local() {
187185
}
188186

189187
/**
190-
* Period to wait for a connection to the master node. If no response is
188+
* The period to wait for a connection to the master node. If no response is
191189
* received before the timeout expires, the request fails and returns an error.
192190
* <p>
193191
* API name: {@code master_timeout}
@@ -198,8 +196,8 @@ public final Time masterTimeout() {
198196
}
199197

200198
/**
201-
* Period to wait for a response. If no response is received before the timeout
202-
* expires, the request fails and returns an error.
199+
* The period to wait for a response. If no response is received before the
200+
* timeout expires, the request fails and returns an error.
203201
* <p>
204202
* API name: {@code timeout}
205203
*/
@@ -209,8 +207,8 @@ public final Time timeout() {
209207
}
210208

211209
/**
212-
* A number controlling to how many active shards to wait for, all to wait for
213-
* all shards in the cluster to be active, or 0 to not wait.
210+
* Wait for the specified number of active shards. Use <code>all</code> to wait
211+
* for all shards in the cluster to be active. Use <code>0</code> to not wait.
214212
* <p>
215213
* API name: {@code wait_for_active_shards}
216214
*/
@@ -220,8 +218,7 @@ public final WaitForActiveShards waitForActiveShards() {
220218
}
221219

222220
/**
223-
* Can be one of immediate, urgent, high, normal, low, languid. Wait until all
224-
* currently queued events with the given priority are processed.
221+
* Wait until all currently queued events with the given priority are processed.
225222
* <p>
226223
* API name: {@code wait_for_events}
227224
*/
@@ -231,9 +228,8 @@ public final WaitForEvents waitForEvents() {
231228
}
232229

233230
/**
234-
* A boolean value which controls whether to wait (until the timeout provided)
235-
* for the cluster to have no shard initializations. Defaults to false, which
236-
* means it will not wait for initializing shards.
231+
* Wait (until the timeout expires) for the cluster to have no shard
232+
* initializations. If false, the request does not wait for initializing shards.
237233
* <p>
238234
* API name: {@code wait_for_no_initializing_shards}
239235
*/
@@ -243,9 +239,8 @@ public final Boolean waitForNoInitializingShards() {
243239
}
244240

245241
/**
246-
* A boolean value which controls whether to wait (until the timeout provided)
247-
* for the cluster to have no shard relocations. Defaults to false, which means
248-
* it will not wait for relocating shards.
242+
* Wait (until the timeout expires) for the cluster to have no shard
243+
* relocations. If false, the request not wait for relocating shards.
249244
* <p>
250245
* API name: {@code wait_for_no_relocating_shards}
251246
*/
@@ -255,9 +250,10 @@ public final Boolean waitForNoRelocatingShards() {
255250
}
256251

257252
/**
258-
* The request waits until the specified number N of nodes is available. It also
259-
* accepts &gt;=N, &lt;=N, &gt;N and &lt;N. Alternatively, it is possible to use
260-
* ge(N), le(N), gt(N) and lt(N) notation.
253+
* Wait until the specified number (N) of nodes is available. It also accepts
254+
* <code>&gt;=N</code>, <code>&lt;=N</code>, <code>&gt;N</code> and
255+
* <code>&lt;N</code>. Alternatively, use the notations <code>ge(N)</code>,
256+
* <code>le(N)</code>, <code>gt(N)</code>, and <code>lt(N)</code>.
261257
* <p>
262258
* API name: {@code wait_for_nodes}
263259
*/
@@ -267,9 +263,10 @@ public final String waitForNodes() {
267263
}
268264

269265
/**
270-
* One of green, yellow or red. Will wait (until the timeout provided) until the
271-
* status of the cluster changes to the one provided or better, i.e. green &gt;
272-
* yellow &gt; red. By default, will not wait for any status.
266+
* Wait (until the timeout expires) for the cluster to reach a specific health
267+
* status (or a better status). A green status is better than yellow and yellow
268+
* is better than red. By default, the request does not wait for a particular
269+
* status.
273270
* <p>
274271
* API name: {@code wait_for_status}
275272
*/
@@ -322,8 +319,7 @@ public static class Builder extends RequestBase.AbstractBuilder<Builder> impleme
322319
private HealthStatus waitForStatus;
323320

324321
/**
325-
* Whether to expand wildcard expression to concrete indices that are open,
326-
* closed or both.
322+
* Expand wildcard expression to concrete indices that are open, closed or both.
327323
* <p>
328324
* API name: {@code expand_wildcards}
329325
* <p>
@@ -335,8 +331,7 @@ public final Builder expandWildcards(List<ExpandWildcard> list) {
335331
}
336332

337333
/**
338-
* Whether to expand wildcard expression to concrete indices that are open,
339-
* closed or both.
334+
* Expand wildcard expression to concrete indices that are open, closed or both.
340335
* <p>
341336
* API name: {@code expand_wildcards}
342337
* <p>
@@ -348,10 +343,10 @@ public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... val
348343
}
349344

350345
/**
351-
* Comma-separated list of data streams, indices, and index aliases used to
352-
* limit the request. Wildcard expressions (<code>*</code>) are supported. To
353-
* target all data streams and indices in a cluster, omit this parameter or use
354-
* _all or <code>*</code>.
346+
* A comma-separated list of data streams, indices, and index aliases that limit
347+
* the request. Wildcard expressions (<code>*</code>) are supported. To target
348+
* all data streams and indices in a cluster, omit this parameter or use _all or
349+
* <code>*</code>.
355350
* <p>
356351
* API name: {@code index}
357352
* <p>
@@ -363,10 +358,10 @@ public final Builder index(List<String> list) {
363358
}
364359

365360
/**
366-
* Comma-separated list of data streams, indices, and index aliases used to
367-
* limit the request. Wildcard expressions (<code>*</code>) are supported. To
368-
* target all data streams and indices in a cluster, omit this parameter or use
369-
* _all or <code>*</code>.
361+
* A comma-separated list of data streams, indices, and index aliases that limit
362+
* the request. Wildcard expressions (<code>*</code>) are supported. To target
363+
* all data streams and indices in a cluster, omit this parameter or use _all or
364+
* <code>*</code>.
370365
* <p>
371366
* API name: {@code index}
372367
* <p>
@@ -378,8 +373,7 @@ public final Builder index(String value, String... values) {
378373
}
379374

380375
/**
381-
* Can be one of cluster, indices or shards. Controls the details level of the
382-
* health information returned.
376+
* Return health information at a specific level of detail.
383377
* <p>
384378
* API name: {@code level}
385379
*/
@@ -389,8 +383,8 @@ public final Builder level(@Nullable Level value) {
389383
}
390384

391385
/**
392-
* If true, the request retrieves information from the local node only. Defaults
393-
* to false, which means information is retrieved from the master node.
386+
* If true, retrieve information from the local node only. If false, retrieve
387+
* information from the master node.
394388
* <p>
395389
* API name: {@code local}
396390
*/
@@ -400,7 +394,7 @@ public final Builder local(@Nullable Boolean value) {
400394
}
401395

402396
/**
403-
* Period to wait for a connection to the master node. If no response is
397+
* The period to wait for a connection to the master node. If no response is
404398
* received before the timeout expires, the request fails and returns an error.
405399
* <p>
406400
* API name: {@code master_timeout}
@@ -411,7 +405,7 @@ public final Builder masterTimeout(@Nullable Time value) {
411405
}
412406

413407
/**
414-
* Period to wait for a connection to the master node. If no response is
408+
* The period to wait for a connection to the master node. If no response is
415409
* received before the timeout expires, the request fails and returns an error.
416410
* <p>
417411
* API name: {@code master_timeout}
@@ -421,8 +415,8 @@ public final Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> f
421415
}
422416

423417
/**
424-
* Period to wait for a response. If no response is received before the timeout
425-
* expires, the request fails and returns an error.
418+
* The period to wait for a response. If no response is received before the
419+
* timeout expires, the request fails and returns an error.
426420
* <p>
427421
* API name: {@code timeout}
428422
*/
@@ -432,8 +426,8 @@ public final Builder timeout(@Nullable Time value) {
432426
}
433427

434428
/**
435-
* Period to wait for a response. If no response is received before the timeout
436-
* expires, the request fails and returns an error.
429+
* The period to wait for a response. If no response is received before the
430+
* timeout expires, the request fails and returns an error.
437431
* <p>
438432
* API name: {@code timeout}
439433
*/
@@ -442,8 +436,8 @@ public final Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
442436
}
443437

444438
/**
445-
* A number controlling to how many active shards to wait for, all to wait for
446-
* all shards in the cluster to be active, or 0 to not wait.
439+
* Wait for the specified number of active shards. Use <code>all</code> to wait
440+
* for all shards in the cluster to be active. Use <code>0</code> to not wait.
447441
* <p>
448442
* API name: {@code wait_for_active_shards}
449443
*/
@@ -453,8 +447,8 @@ public final Builder waitForActiveShards(@Nullable WaitForActiveShards value) {
453447
}
454448

455449
/**
456-
* A number controlling to how many active shards to wait for, all to wait for
457-
* all shards in the cluster to be active, or 0 to not wait.
450+
* Wait for the specified number of active shards. Use <code>all</code> to wait
451+
* for all shards in the cluster to be active. Use <code>0</code> to not wait.
458452
* <p>
459453
* API name: {@code wait_for_active_shards}
460454
*/
@@ -464,8 +458,7 @@ public final Builder waitForActiveShards(
464458
}
465459

466460
/**
467-
* Can be one of immediate, urgent, high, normal, low, languid. Wait until all
468-
* currently queued events with the given priority are processed.
461+
* Wait until all currently queued events with the given priority are processed.
469462
* <p>
470463
* API name: {@code wait_for_events}
471464
*/
@@ -475,9 +468,8 @@ public final Builder waitForEvents(@Nullable WaitForEvents value) {
475468
}
476469

477470
/**
478-
* A boolean value which controls whether to wait (until the timeout provided)
479-
* for the cluster to have no shard initializations. Defaults to false, which
480-
* means it will not wait for initializing shards.
471+
* Wait (until the timeout expires) for the cluster to have no shard
472+
* initializations. If false, the request does not wait for initializing shards.
481473
* <p>
482474
* API name: {@code wait_for_no_initializing_shards}
483475
*/
@@ -487,9 +479,8 @@ public final Builder waitForNoInitializingShards(@Nullable Boolean value) {
487479
}
488480

489481
/**
490-
* A boolean value which controls whether to wait (until the timeout provided)
491-
* for the cluster to have no shard relocations. Defaults to false, which means
492-
* it will not wait for relocating shards.
482+
* Wait (until the timeout expires) for the cluster to have no shard
483+
* relocations. If false, the request not wait for relocating shards.
493484
* <p>
494485
* API name: {@code wait_for_no_relocating_shards}
495486
*/
@@ -499,9 +490,10 @@ public final Builder waitForNoRelocatingShards(@Nullable Boolean value) {
499490
}
500491

501492
/**
502-
* The request waits until the specified number N of nodes is available. It also
503-
* accepts &gt;=N, &lt;=N, &gt;N and &lt;N. Alternatively, it is possible to use
504-
* ge(N), le(N), gt(N) and lt(N) notation.
493+
* Wait until the specified number (N) of nodes is available. It also accepts
494+
* <code>&gt;=N</code>, <code>&lt;=N</code>, <code>&gt;N</code> and
495+
* <code>&lt;N</code>. Alternatively, use the notations <code>ge(N)</code>,
496+
* <code>le(N)</code>, <code>gt(N)</code>, and <code>lt(N)</code>.
505497
* <p>
506498
* API name: {@code wait_for_nodes}
507499
*/
@@ -511,9 +503,10 @@ public final Builder waitForNodes(@Nullable String value) {
511503
}
512504

513505
/**
514-
* One of green, yellow or red. Will wait (until the timeout provided) until the
515-
* status of the cluster changes to the one provided or better, i.e. green &gt;
516-
* yellow &gt; red. By default, will not wait for any status.
506+
* Wait (until the timeout expires) for the cluster to reach a specific health
507+
* status (or a better status). A green status is better than yellow and yellow
508+
* is better than red. By default, the request does not wait for a particular
509+
* status.
517510
* <p>
518511
* API name: {@code wait_for_status}
519512
*/

0 commit comments

Comments
 (0)