Skip to content

Commit 72f9668

Browse files
Re-generate client code using latest OpenSearch API specification (2025-03-17)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent eab4091 commit 72f9668

File tree

4 files changed

+244
-69
lines changed

4 files changed

+244
-69
lines changed

java-client/src/generated/java/org/opensearch/client/opensearch/tasks/CancelRequest.java

+18-12
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public static CancelRequest of(Function<CancelRequest.Builder, ObjectBuilder<Can
9292
}
9393

9494
/**
95-
* Comma-separated list or wildcard expression of actions used to limit the request.
95+
* A comma-separated list of actions that should be returned. Keep empty to return all.
9696
* <p>
9797
* API name: {@code actions}
9898
* </p>
@@ -103,7 +103,9 @@ public final List<String> actions() {
103103
}
104104

105105
/**
106-
* Comma-separated list of node IDs or names used to limit the request.
106+
* A comma-separated list of node IDs or names to limit the returned information. Use <code>_local</code> to return information from the
107+
* node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get
108+
* information from all nodes.
107109
* <p>
108110
* API name: {@code nodes}
109111
* </p>
@@ -114,7 +116,7 @@ public final List<String> nodes() {
114116
}
115117

116118
/**
117-
* Parent task ID used to limit the tasks.
119+
* Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
118120
* <p>
119121
* API name: {@code parent_task_id}
120122
* </p>
@@ -125,7 +127,7 @@ public final String parentTaskId() {
125127
}
126128

127129
/**
128-
* ID of the task.
130+
* The ID of the task.
129131
* <p>
130132
* API name: {@code task_id}
131133
* </p>
@@ -136,7 +138,7 @@ public final String taskId() {
136138
}
137139

138140
/**
139-
* Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
141+
* Waits for the matching task to complete. When <code>true</code>, the request is blocked until the task has completed.
140142
* <p>
141143
* API name: {@code wait_for_completion}
142144
* </p>
@@ -207,7 +209,7 @@ protected Builder self() {
207209
}
208210

209211
/**
210-
* Comma-separated list or wildcard expression of actions used to limit the request.
212+
* A comma-separated list of actions that should be returned. Keep empty to return all.
211213
* <p>
212214
* API name: {@code actions}
213215
* </p>
@@ -223,7 +225,7 @@ public final Builder actions(List<String> list) {
223225
}
224226

225227
/**
226-
* Comma-separated list or wildcard expression of actions used to limit the request.
228+
* A comma-separated list of actions that should be returned. Keep empty to return all.
227229
* <p>
228230
* API name: {@code actions}
229231
* </p>
@@ -239,7 +241,9 @@ public final Builder actions(String value, String... values) {
239241
}
240242

241243
/**
242-
* Comma-separated list of node IDs or names used to limit the request.
244+
* A comma-separated list of node IDs or names to limit the returned information. Use <code>_local</code> to return information from
245+
* the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get
246+
* information from all nodes.
243247
* <p>
244248
* API name: {@code nodes}
245249
* </p>
@@ -255,7 +259,9 @@ public final Builder nodes(List<String> list) {
255259
}
256260

257261
/**
258-
* Comma-separated list of node IDs or names used to limit the request.
262+
* A comma-separated list of node IDs or names to limit the returned information. Use <code>_local</code> to return information from
263+
* the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get
264+
* information from all nodes.
259265
* <p>
260266
* API name: {@code nodes}
261267
* </p>
@@ -271,7 +277,7 @@ public final Builder nodes(String value, String... values) {
271277
}
272278

273279
/**
274-
* Parent task ID used to limit the tasks.
280+
* Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
275281
* <p>
276282
* API name: {@code parent_task_id}
277283
* </p>
@@ -283,7 +289,7 @@ public final Builder parentTaskId(@Nullable String value) {
283289
}
284290

285291
/**
286-
* ID of the task.
292+
* The ID of the task.
287293
* <p>
288294
* API name: {@code task_id}
289295
* </p>
@@ -295,7 +301,7 @@ public final Builder taskId(@Nullable String value) {
295301
}
296302

297303
/**
298-
* Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false
304+
* Waits for the matching task to complete. When <code>true</code>, the request is blocked until the task has completed.
299305
* <p>
300306
* API name: {@code wait_for_completion}
301307
* </p>

java-client/src/generated/java/org/opensearch/client/opensearch/tasks/GetTasksRequest.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public static GetTasksRequest of(Function<GetTasksRequest.Builder, ObjectBuilder
8484
}
8585

8686
/**
87-
* Required - ID of the task.
87+
* Required - The ID of the task.
8888
* <p>
8989
* API name: {@code task_id}
9090
* </p>
@@ -95,7 +95,7 @@ public final String taskId() {
9595
}
9696

9797
/**
98-
* Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
98+
* The amount of time to wait for a response.
9999
* <p>
100100
* API name: {@code timeout}
101101
* </p>
@@ -106,7 +106,7 @@ public final Time timeout() {
106106
}
107107

108108
/**
109-
* If <code>true</code>, the request blocks until the task has completed.
109+
* Waits for the matching task to complete. When <code>true</code>, the request is blocked until the task has completed.
110110
* <p>
111111
* API name: {@code wait_for_completion}
112112
* </p>
@@ -168,7 +168,7 @@ protected Builder self() {
168168
}
169169

170170
/**
171-
* Required - ID of the task.
171+
* Required - The ID of the task.
172172
* <p>
173173
* API name: {@code task_id}
174174
* </p>
@@ -180,7 +180,7 @@ public final Builder taskId(String value) {
180180
}
181181

182182
/**
183-
* Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
183+
* The amount of time to wait for a response.
184184
* <p>
185185
* API name: {@code timeout}
186186
* </p>
@@ -192,7 +192,7 @@ public final Builder timeout(@Nullable Time value) {
192192
}
193193

194194
/**
195-
* Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
195+
* The amount of time to wait for a response.
196196
* <p>
197197
* API name: {@code timeout}
198198
* </p>
@@ -203,7 +203,7 @@ public final Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
203203
}
204204

205205
/**
206-
* If <code>true</code>, the request blocks until the task has completed.
206+
* Waits for the matching task to complete. When <code>true</code>, the request is blocked until the task has completed.
207207
* <p>
208208
* API name: {@code wait_for_completion}
209209
* </p>

java-client/src/generated/java/org/opensearch/client/opensearch/tasks/ListRequest.java

+23-20
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public static ListRequest of(Function<ListRequest.Builder, ObjectBuilder<ListReq
101101
}
102102

103103
/**
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.
105105
* <p>
106106
* API name: {@code actions}
107107
* </p>
@@ -112,7 +112,7 @@ public final List<String> actions() {
112112
}
113113

114114
/**
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.
116116
* <p>
117117
* API name: {@code detailed}
118118
* </p>
@@ -123,7 +123,7 @@ public final Boolean detailed() {
123123
}
124124

125125
/**
126-
* Key used to group tasks in the response.
126+
* Groups tasks by parent/child relationships or nodes.
127127
* <p>
128128
* API name: {@code group_by}
129129
* </p>
@@ -134,8 +134,9 @@ public final GroupBy groupBy() {
134134
}
135135

136136
/**
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.
139140
* <p>
140141
* API name: {@code nodes}
141142
* </p>
@@ -146,7 +147,7 @@ public final List<String> nodes() {
146147
}
147148

148149
/**
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.
150151
* <p>
151152
* API name: {@code parent_task_id}
152153
* </p>
@@ -157,7 +158,7 @@ public final String parentTaskId() {
157158
}
158159

159160
/**
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.
161162
* <p>
162163
* API name: {@code timeout}
163164
* </p>
@@ -168,7 +169,7 @@ public final Time timeout() {
168169
}
169170

170171
/**
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.
172173
* <p>
173174
* API name: {@code wait_for_completion}
174175
* </p>
@@ -247,7 +248,7 @@ protected Builder self() {
247248
}
248249

249250
/**
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.
251252
* <p>
252253
* API name: {@code actions}
253254
* </p>
@@ -263,7 +264,7 @@ public final Builder actions(List<String> list) {
263264
}
264265

265266
/**
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.
267268
* <p>
268269
* API name: {@code actions}
269270
* </p>
@@ -279,7 +280,7 @@ public final Builder actions(String value, String... values) {
279280
}
280281

281282
/**
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.
283284
* <p>
284285
* API name: {@code detailed}
285286
* </p>
@@ -291,7 +292,7 @@ public final Builder detailed(@Nullable Boolean value) {
291292
}
292293

293294
/**
294-
* Key used to group tasks in the response.
295+
* Groups tasks by parent/child relationships or nodes.
295296
* <p>
296297
* API name: {@code group_by}
297298
* </p>
@@ -303,8 +304,9 @@ public final Builder groupBy(@Nullable GroupBy value) {
303304
}
304305

305306
/**
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.
308310
* <p>
309311
* API name: {@code nodes}
310312
* </p>
@@ -320,8 +322,9 @@ public final Builder nodes(List<String> list) {
320322
}
321323

322324
/**
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.
325328
* <p>
326329
* API name: {@code nodes}
327330
* </p>
@@ -337,7 +340,7 @@ public final Builder nodes(String value, String... values) {
337340
}
338341

339342
/**
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.
341344
* <p>
342345
* API name: {@code parent_task_id}
343346
* </p>
@@ -349,7 +352,7 @@ public final Builder parentTaskId(@Nullable String value) {
349352
}
350353

351354
/**
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.
353356
* <p>
354357
* API name: {@code timeout}
355358
* </p>
@@ -361,7 +364,7 @@ public final Builder timeout(@Nullable Time value) {
361364
}
362365

363366
/**
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.
365368
* <p>
366369
* API name: {@code timeout}
367370
* </p>
@@ -372,7 +375,7 @@ public final Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
372375
}
373376

374377
/**
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.
376379
* <p>
377380
* API name: {@code wait_for_completion}
378381
* </p>

0 commit comments

Comments
 (0)