@@ -101,7 +101,7 @@ public static ListRequest of(Function<ListRequest.Builder, ObjectBuilder<ListReq
101
101
}
102
102
103
103
/**
104
- * Comma -separated list or wildcard expression of actions used to limit the request .
104
+ * A comma -separated list of actions that should be returned. Keep empty to return all .
105
105
* <p>
106
106
* API name: {@code actions}
107
107
* </p>
@@ -112,7 +112,7 @@ public final List<String> actions() {
112
112
}
113
113
114
114
/**
115
- * If <code>true</code>, the response includes detailed information about shard recoveries.
115
+ * When <code>true</code>, the response includes detailed information about shard recoveries.
116
116
* <p>
117
117
* API name: {@code detailed}
118
118
* </p>
@@ -123,7 +123,7 @@ public final Boolean detailed() {
123
123
}
124
124
125
125
/**
126
- * Key used to group tasks in the response .
126
+ * Groups tasks by parent/child relationships or nodes .
127
127
* <p>
128
128
* API name: {@code group_by}
129
129
* </p>
@@ -134,8 +134,9 @@ public final GroupBy groupBy() {
134
134
}
135
135
136
136
/**
137
- * Comma-separated list of node IDs or names to limit the returned information; use <code>_local</code> to return information from the
138
- * node you're connecting to, leave empty to get information from all nodes.
137
+ * A comma-separated list of node IDs or names to limit the returned information. Use <code>_local</code> to return information from the
138
+ * node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get
139
+ * information from all nodes.
139
140
* <p>
140
141
* API name: {@code nodes}
141
142
* </p>
@@ -146,7 +147,7 @@ public final List<String> nodes() {
146
147
}
147
148
148
149
/**
149
- * Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of <code>-1</code> .
150
+ * Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all .
150
151
* <p>
151
152
* API name: {@code parent_task_id}
152
153
* </p>
@@ -157,7 +158,7 @@ public final String parentTaskId() {
157
158
}
158
159
159
160
/**
160
- * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error .
161
+ * The amount of time to wait for a response.
161
162
* <p>
162
163
* API name: {@code timeout}
163
164
* </p>
@@ -168,7 +169,7 @@ public final Time timeout() {
168
169
}
169
170
170
171
/**
171
- * If <code>true</code>, the request blocks until the operation is complete .
172
+ * Waits for the matching task to complete. When <code>true</code>, the request is blocked until the task has completed .
172
173
* <p>
173
174
* API name: {@code wait_for_completion}
174
175
* </p>
@@ -247,7 +248,7 @@ protected Builder self() {
247
248
}
248
249
249
250
/**
250
- * Comma -separated list or wildcard expression of actions used to limit the request .
251
+ * A comma -separated list of actions that should be returned. Keep empty to return all .
251
252
* <p>
252
253
* API name: {@code actions}
253
254
* </p>
@@ -263,7 +264,7 @@ public final Builder actions(List<String> list) {
263
264
}
264
265
265
266
/**
266
- * Comma -separated list or wildcard expression of actions used to limit the request .
267
+ * A comma -separated list of actions that should be returned. Keep empty to return all .
267
268
* <p>
268
269
* API name: {@code actions}
269
270
* </p>
@@ -279,7 +280,7 @@ public final Builder actions(String value, String... values) {
279
280
}
280
281
281
282
/**
282
- * If <code>true</code>, the response includes detailed information about shard recoveries.
283
+ * When <code>true</code>, the response includes detailed information about shard recoveries.
283
284
* <p>
284
285
* API name: {@code detailed}
285
286
* </p>
@@ -291,7 +292,7 @@ public final Builder detailed(@Nullable Boolean value) {
291
292
}
292
293
293
294
/**
294
- * Key used to group tasks in the response .
295
+ * Groups tasks by parent/child relationships or nodes .
295
296
* <p>
296
297
* API name: {@code group_by}
297
298
* </p>
@@ -303,8 +304,9 @@ public final Builder groupBy(@Nullable GroupBy value) {
303
304
}
304
305
305
306
/**
306
- * Comma-separated list of node IDs or names to limit the returned information; use <code>_local</code> to return information from
307
- * the node you're connecting to, leave empty to get information from all nodes.
307
+ * A comma-separated list of node IDs or names to limit the returned information. Use <code>_local</code> to return information from
308
+ * the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get
309
+ * information from all nodes.
308
310
* <p>
309
311
* API name: {@code nodes}
310
312
* </p>
@@ -320,8 +322,9 @@ public final Builder nodes(List<String> list) {
320
322
}
321
323
322
324
/**
323
- * Comma-separated list of node IDs or names to limit the returned information; use <code>_local</code> to return information from
324
- * the node you're connecting to, leave empty to get information from all nodes.
325
+ * A comma-separated list of node IDs or names to limit the returned information. Use <code>_local</code> to return information from
326
+ * the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get
327
+ * information from all nodes.
325
328
* <p>
326
329
* API name: {@code nodes}
327
330
* </p>
@@ -337,7 +340,7 @@ public final Builder nodes(String value, String... values) {
337
340
}
338
341
339
342
/**
340
- * Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of <code>-1</code> .
343
+ * Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all .
341
344
* <p>
342
345
* API name: {@code parent_task_id}
343
346
* </p>
@@ -349,7 +352,7 @@ public final Builder parentTaskId(@Nullable String value) {
349
352
}
350
353
351
354
/**
352
- * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error .
355
+ * The amount of time to wait for a response.
353
356
* <p>
354
357
* API name: {@code timeout}
355
358
* </p>
@@ -361,7 +364,7 @@ public final Builder timeout(@Nullable Time value) {
361
364
}
362
365
363
366
/**
364
- * Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error .
367
+ * The amount of time to wait for a response.
365
368
* <p>
366
369
* API name: {@code timeout}
367
370
* </p>
@@ -372,7 +375,7 @@ public final Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
372
375
}
373
376
374
377
/**
375
- * If <code>true</code>, the request blocks until the operation is complete .
378
+ * Waits for the matching task to complete. When <code>true</code>, the request is blocked until the task has completed .
376
379
* <p>
377
380
* API name: {@code wait_for_completion}
378
381
* </p>
0 commit comments