Skip to content

Commit eab4091

Browse files
opensearch-trigger-bot[bot]github-actions[bot]Xtansia
authored
Re-generated client code using latest OpenSearch API specification (#1479)
* Re-generate client code using latest OpenSearch API specification (2025-03-10) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix url Signed-off-by: Thomas Farr <[email protected]> --------- Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: Thomas Farr <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Thomas Farr <[email protected]>
1 parent cc5278f commit eab4091

14 files changed

+199
-136
lines changed

‎java-client/src/generated/java/org/opensearch/client/opensearch/_types/WaitForEvents.java

+18
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,34 @@
4848
@JsonpDeserializable
4949
@Generated("org.opensearch.client.codegen.CodeGenerator")
5050
public enum WaitForEvents implements JsonEnum {
51+
/**
52+
* High priority, processed after urgent events.
53+
*/
5154
High("high"),
5255

56+
/**
57+
* Highest priority, processed as soon as possible.
58+
*/
5359
Immediate("immediate"),
5460

61+
/**
62+
* Lowest priority, processed after all other events.
63+
*/
5564
Languid("languid"),
5665

66+
/**
67+
* Low priority, processed after normal events.
68+
*/
5769
Low("low"),
5870

71+
/**
72+
* Default priority, processed after high priority events.
73+
*/
5974
Normal("normal"),
6075

76+
/**
77+
* Very high priority, processed after immediate events.
78+
*/
6179
Urgent("urgent");
6280

6381
private final String jsonValue;

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/AllocationExplainRequest.java

+4-2
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ public final Boolean includeDiskInfo() {
128128
}
129129

130130
/**
131-
* When <code>true</code>, returns any <code>YES</code> decisions in the allocation explanation.
131+
* When <code>true</code>, returns any <code>YES</code> decisions in the allocation explanation. <code>YES</code> decisions indicate
132+
* when a particular shard allocation attempt was successful for the given node.
132133
* <p>
133134
* API name: {@code include_yes_decisions}
134135
* </p>
@@ -289,7 +290,8 @@ public final Builder includeDiskInfo(@Nullable Boolean value) {
289290
}
290291

291292
/**
292-
* When <code>true</code>, returns any <code>YES</code> decisions in the allocation explanation.
293+
* When <code>true</code>, returns any <code>YES</code> decisions in the allocation explanation. <code>YES</code> decisions indicate
294+
* when a particular shard allocation attempt was successful for the given node.
293295
* <p>
294296
* API name: {@code include_yes_decisions}
295297
* </p>

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/DeleteComponentTemplateRequest.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ public static DeleteComponentTemplateRequest of(
9393
}
9494

9595
/**
96-
* Operation timeout for connection to cluster-manager node.
96+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
97+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
9798
* <p>
9899
* API name: {@code cluster_manager_timeout}
99100
* </p>
@@ -199,7 +200,8 @@ protected Builder self() {
199200
}
200201

201202
/**
202-
* Operation timeout for connection to cluster-manager node.
203+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
204+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
203205
* <p>
204206
* API name: {@code cluster_manager_timeout}
205207
* </p>
@@ -211,7 +213,8 @@ public final Builder clusterManagerTimeout(@Nullable Time value) {
211213
}
212214

213215
/**
214-
* Operation timeout for connection to cluster-manager node.
216+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
217+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
215218
* <p>
216219
* API name: {@code cluster_manager_timeout}
217220
* </p>

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/ExistsComponentTemplateRequest.java

+6-9
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,8 @@ public static ExistsComponentTemplateRequest of(
9595
}
9696

9797
/**
98-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
99-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
100-
* &quot;-1&quot; to indicate an unspecified value.
98+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
99+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
101100
* <p>
102101
* API name: {@code cluster_manager_timeout}
103102
* </p>
@@ -202,9 +201,8 @@ protected Builder self() {
202201
}
203202

204203
/**
205-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
206-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
207-
* &quot;-1&quot; to indicate an unspecified value.
204+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
205+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
208206
* <p>
209207
* API name: {@code cluster_manager_timeout}
210208
* </p>
@@ -216,9 +214,8 @@ public final Builder clusterManagerTimeout(@Nullable Time value) {
216214
}
217215

218216
/**
219-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
220-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
221-
* &quot;-1&quot; to indicate an unspecified value.
217+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
218+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
222219
* <p>
223220
* API name: {@code cluster_manager_timeout}
224221
* </p>

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/GetClusterSettingsRequest.java

+6-9
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,8 @@ public static GetClusterSettingsRequest of(Function<GetClusterSettingsRequest.Bu
9494
}
9595

9696
/**
97-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
98-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
99-
* &quot;-1&quot; to indicate an unspecified value.
97+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
98+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
10099
* <p>
101100
* API name: {@code cluster_manager_timeout}
102101
* </p>
@@ -218,9 +217,8 @@ protected Builder self() {
218217
}
219218

220219
/**
221-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
222-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
223-
* &quot;-1&quot; to indicate an unspecified value.
220+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
221+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
224222
* <p>
225223
* API name: {@code cluster_manager_timeout}
226224
* </p>
@@ -232,9 +230,8 @@ public final Builder clusterManagerTimeout(@Nullable Time value) {
232230
}
233231

234232
/**
235-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
236-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
237-
* &quot;-1&quot; to indicate an unspecified value.
233+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
234+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
238235
* <p>
239236
* API name: {@code cluster_manager_timeout}
240237
* </p>

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/GetComponentTemplateRequest.java

+12-11
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,8 @@ public static GetComponentTemplateRequest of(
9696
}
9797

9898
/**
99-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
100-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
101-
* &quot;-1&quot; to indicate an unspecified value.
99+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
100+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
102101
* <p>
103102
* API name: {@code cluster_manager_timeout}
104103
* </p>
@@ -109,7 +108,9 @@ public final Time clusterManagerTimeout() {
109108
}
110109

111110
/**
112-
* If <code>true</code>, returns settings in flat format.
111+
* Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the
112+
* flat form of <code>&quot;cluster&quot;: { &quot;max_shards_per_node&quot;: 500 }</code> is
113+
* <code>&quot;cluster.max_shards_per_node&quot;: &quot;500&quot;</code>.
113114
* <p>
114115
* API name: {@code flat_settings}
115116
* </p>
@@ -219,9 +220,8 @@ protected Builder self() {
219220
}
220221

221222
/**
222-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
223-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
224-
* &quot;-1&quot; to indicate an unspecified value.
223+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
224+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
225225
* <p>
226226
* API name: {@code cluster_manager_timeout}
227227
* </p>
@@ -233,9 +233,8 @@ public final Builder clusterManagerTimeout(@Nullable Time value) {
233233
}
234234

235235
/**
236-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
237-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
238-
* &quot;-1&quot; to indicate an unspecified value.
236+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
237+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
239238
* <p>
240239
* API name: {@code cluster_manager_timeout}
241240
* </p>
@@ -246,7 +245,9 @@ public final Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<
246245
}
247246

248247
/**
249-
* If <code>true</code>, returns settings in flat format.
248+
* Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example,
249+
* the flat form of <code>&quot;cluster&quot;: { &quot;max_shards_per_node&quot;: 500 }</code> is
250+
* <code>&quot;cluster.max_shards_per_node&quot;: &quot;500&quot;</code>.
250251
* <p>
251252
* API name: {@code flat_settings}
252253
* </p>

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/HealthRequest.java

+12-18
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,8 @@ public final String awarenessAttribute() {
148148
}
149149

150150
/**
151-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
152-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
153-
* &quot;-1&quot; to indicate an unspecified value.
151+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
152+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
154153
* <p>
155154
* API name: {@code cluster_manager_timeout}
156155
* </p>
@@ -220,9 +219,8 @@ public final Time masterTimeout() {
220219
}
221220

222221
/**
223-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
224-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
225-
* &quot;-1&quot; to indicate an unspecified value.
222+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
223+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
226224
* <p>
227225
* API name: {@code timeout}
228226
* </p>
@@ -410,9 +408,8 @@ public final Builder awarenessAttribute(@Nullable String value) {
410408
}
411409

412410
/**
413-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
414-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
415-
* &quot;-1&quot; to indicate an unspecified value.
411+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
412+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
416413
* <p>
417414
* API name: {@code cluster_manager_timeout}
418415
* </p>
@@ -424,9 +421,8 @@ public final Builder clusterManagerTimeout(@Nullable Time value) {
424421
}
425422

426423
/**
427-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
428-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
429-
* &quot;-1&quot; to indicate an unspecified value.
424+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
425+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
430426
* <p>
431427
* API name: {@code cluster_manager_timeout}
432428
* </p>
@@ -556,9 +552,8 @@ public final Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> f
556552
}
557553

558554
/**
559-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
560-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
561-
* &quot;-1&quot; to indicate an unspecified value.
555+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
556+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
562557
* <p>
563558
* API name: {@code timeout}
564559
* </p>
@@ -570,9 +565,8 @@ public final Builder timeout(@Nullable Time value) {
570565
}
571566

572567
/**
573-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
574-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
575-
* &quot;-1&quot; to indicate an unspecified value.
568+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
569+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
576570
* <p>
577571
* API name: {@code timeout}
578572
* </p>

‎java-client/src/generated/java/org/opensearch/client/opensearch/cluster/PendingTasksRequest.java

+6-9
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,8 @@ public static PendingTasksRequest of(Function<PendingTasksRequest.Builder, Objec
8484
}
8585

8686
/**
87-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
88-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
89-
* &quot;-1&quot; to indicate an unspecified value.
87+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
88+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
9089
* <p>
9190
* API name: {@code cluster_manager_timeout}
9291
* </p>
@@ -175,9 +174,8 @@ protected Builder self() {
175174
}
176175

177176
/**
178-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
179-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
180-
* &quot;-1&quot; to indicate an unspecified value.
177+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
178+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
181179
* <p>
182180
* API name: {@code cluster_manager_timeout}
183181
* </p>
@@ -189,9 +187,8 @@ public final Builder clusterManagerTimeout(@Nullable Time value) {
189187
}
190188

191189
/**
192-
* A duration. Units can be <code>nanos</code>, <code>micros</code>, <code>ms</code> (milliseconds), <code>s</code> (seconds),
193-
* <code>m</code> (minutes), <code>h</code> (hours) and <code>d</code> (days). Also accepts &quot;0&quot; without a unit and
194-
* &quot;-1&quot; to indicate an unspecified value.
190+
* The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see
191+
* <a href="https://opensearch.org/docs/latest/api-reference/common-parameters/#time-units">Common parameters</a>.
195192
* <p>
196193
* API name: {@code cluster_manager_timeout}
197194
* </p>

0 commit comments

Comments
 (0)