Skip to content

Commit 405e1d4

Browse files
committed
[codegen] Update to latest API spec
1 parent b6cf6b8 commit 405e1d4

File tree

130 files changed

+2951
-1387
lines changed

Some content is hidden

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

130 files changed

+2951
-1387
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,14 @@
3434
*/
3535
@JsonpDeserializable
3636
public enum GeoDistanceType implements JsonEnum {
37+
/**
38+
* The <code>arc</code> calculation is the most accurate.
39+
*/
3740
Arc("arc"),
3841

42+
/**
43+
* The <code>plane</code> calculation is faster but less accurate.
44+
*/
3945
Plane("plane"),
4046

4147
;

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,18 @@ public static LatLonGeoLocation of(Function<Builder, ObjectBuilder<LatLonGeoLoca
6565
}
6666

6767
/**
68-
* Required - API name: {@code lat}
68+
* Required - Latitude
69+
* <p>
70+
* API name: {@code lat}
6971
*/
7072
public final double lat() {
7173
return this.lat;
7274
}
7375

7476
/**
75-
* Required - API name: {@code lon}
77+
* Required - Longitude
78+
* <p>
79+
* API name: {@code lon}
7680
*/
7781
public final double lon() {
7882
return this.lon;
@@ -114,15 +118,19 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder> implement
114118
private Double lon;
115119

116120
/**
117-
* Required - API name: {@code lat}
121+
* Required - Latitude
122+
* <p>
123+
* API name: {@code lat}
118124
*/
119125
public final Builder lat(double value) {
120126
this.lat = value;
121127
return this;
122128
}
123129

124130
/**
125-
* Required - API name: {@code lon}
131+
* Required - Longitude
132+
* <p>
133+
* API name: {@code lon}
126134
*/
127135
public final Builder lon(double value) {
128136
this.lon = value;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/AggregationRange.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ public static AggregationRange of(Function<Builder, ObjectBuilder<AggregationRan
7272
}
7373

7474
/**
75+
* Start of the range (inclusive).
76+
* <p>
7577
* API name: {@code from}
7678
*/
7779
@Nullable
@@ -80,6 +82,8 @@ public final String from() {
8082
}
8183

8284
/**
85+
* Custom key to return the range with.
86+
* <p>
8387
* API name: {@code key}
8488
*/
8589
@Nullable
@@ -88,6 +92,8 @@ public final String key() {
8892
}
8993

9094
/**
95+
* End of the range (exclusive).
96+
* <p>
9197
* API name: {@code to}
9298
*/
9399
@Nullable
@@ -146,6 +152,8 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder> implement
146152
private String to;
147153

148154
/**
155+
* Start of the range (inclusive).
156+
* <p>
149157
* API name: {@code from}
150158
*/
151159
public final Builder from(@Nullable String value) {
@@ -154,6 +162,8 @@ public final Builder from(@Nullable String value) {
154162
}
155163

156164
/**
165+
* Custom key to return the range with.
166+
* <p>
157167
* API name: {@code key}
158168
*/
159169
public final Builder key(@Nullable String value) {
@@ -162,6 +172,8 @@ public final Builder key(@Nullable String value) {
162172
}
163173

164174
/**
175+
* End of the range (exclusive).
176+
* <p>
165177
* API name: {@code to}
166178
*/
167179
public final Builder to(@Nullable String value) {

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/BoxplotAggregation.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ public Aggregation.Kind _aggregationKind() {
7070
}
7171

7272
/**
73-
* Controls memory usage and approximation error by limiting the maximum number
74-
* of nodes used by the underlying TDigest algorithm to
75-
* <code>20 * compression</code>.
73+
* Limits the maximum number of nodes used by the underlying TDigest algorithm
74+
* to <code>20 * compression</code>, enabling control of memory usage and
75+
* approximation error.
7676
* <p>
7777
* API name: {@code compression}
7878
*/
@@ -105,9 +105,9 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder<Builde
105105
private Double compression;
106106

107107
/**
108-
* Controls memory usage and approximation error by limiting the maximum number
109-
* of nodes used by the underlying TDigest algorithm to
110-
* <code>20 * compression</code>.
108+
* Limits the maximum number of nodes used by the underlying TDigest algorithm
109+
* to <code>20 * compression</code>, enabling control of memory usage and
110+
* approximation error.
111111
* <p>
112112
* API name: {@code compression}
113113
*/

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CardinalityExecutionMode.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@
3636
@JsonpDeserializable
3737
public enum CardinalityExecutionMode implements JsonEnum {
3838
/**
39-
* Run aggregation by using global ordinals of the field and resolving those
39+
* Run the aggregation by using global ordinals of the field and resolving those
4040
* values after finishing a shard.
4141
*/
4242
GlobalOrdinals("global_ordinals"),
4343

4444
/**
45-
* Run aggregation by using segment ordinal values and resolving those values
46-
* after each segment.
45+
* Run the aggregation by using segment ordinal values and resolving those
46+
* values after each segment.
4747
*/
4848
SegmentOrdinals("segment_ordinals"),
4949

5050
/**
51-
* Run aggregation by using field values directly.
51+
* Run the aggregation by using field values directly.
5252
*/
5353
Direct("direct"),
5454

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CategorizeTextAggregation.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ public final Integer size() {
214214
}
215215

216216
/**
217-
* The minimum number of documents for a bucket to be returned to the results.
217+
* The minimum number of documents in a bucket to be returned to the results.
218218
* <p>
219219
* API name: {@code min_doc_count}
220220
*/
@@ -224,7 +224,7 @@ public final Integer minDocCount() {
224224
}
225225

226226
/**
227-
* The minimum number of documents for a bucket to be returned from the shard
227+
* The minimum number of documents in a bucket to be returned from the shard
228228
* before merging.
229229
* <p>
230230
* API name: {@code shard_min_doc_count}
@@ -475,7 +475,7 @@ public final Builder size(@Nullable Integer value) {
475475
}
476476

477477
/**
478-
* The minimum number of documents for a bucket to be returned to the results.
478+
* The minimum number of documents in a bucket to be returned to the results.
479479
* <p>
480480
* API name: {@code min_doc_count}
481481
*/
@@ -485,7 +485,7 @@ public final Builder minDocCount(@Nullable Integer value) {
485485
}
486486

487487
/**
488-
* The minimum number of documents for a bucket to be returned from the shard
488+
* The minimum number of documents in a bucket to be returned from the shard
489489
* before merging.
490490
* <p>
491491
* API name: {@code shard_min_doc_count}

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ChiSquareHeuristic.java

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,21 @@ public static ChiSquareHeuristic of(Function<Builder, ObjectBuilder<ChiSquareHeu
6767
}
6868

6969
/**
70-
* Required - API name: {@code background_is_superset}
70+
* Required - Set to <code>false</code> if you defined a custom background
71+
* filter that represents a different set of documents that you want to compare
72+
* to.
73+
* <p>
74+
* API name: {@code background_is_superset}
7175
*/
7276
public final boolean backgroundIsSuperset() {
7377
return this.backgroundIsSuperset;
7478
}
7579

7680
/**
77-
* Required - API name: {@code include_negatives}
81+
* Required - Set to <code>false</code> to filter out the terms that appear less
82+
* often in the subset than in documents outside the subset.
83+
* <p>
84+
* API name: {@code include_negatives}
7885
*/
7986
public final boolean includeNegatives() {
8087
return this.includeNegatives;
@@ -118,15 +125,22 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder>
118125
private Boolean includeNegatives;
119126

120127
/**
121-
* Required - API name: {@code background_is_superset}
128+
* Required - Set to <code>false</code> if you defined a custom background
129+
* filter that represents a different set of documents that you want to compare
130+
* to.
131+
* <p>
132+
* API name: {@code background_is_superset}
122133
*/
123134
public final Builder backgroundIsSuperset(boolean value) {
124135
this.backgroundIsSuperset = value;
125136
return this;
126137
}
127138

128139
/**
129-
* Required - API name: {@code include_negatives}
140+
* Required - Set to <code>false</code> to filter out the terms that appear less
141+
* often in the subset than in documents outside the subset.
142+
* <p>
143+
* API name: {@code include_negatives}
130144
*/
131145
public final Builder includeNegatives(boolean value) {
132146
this.includeNegatives = value;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateHistogramAggregation.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ public final Time offset() {
255255
}
256256

257257
/**
258-
* The order of the returned buckets.
258+
* The sort order of the returned buckets.
259259
* <p>
260260
* API name: {@code order}
261261
*/
@@ -291,7 +291,7 @@ public final String timeZone() {
291291

292292
/**
293293
* Set to <code>true</code> to associate a unique string key with each bucket
294-
* and returns the ranges as a hash rather than an array.
294+
* and return the ranges as a hash rather than an array.
295295
* <p>
296296
* API name: {@code keyed}
297297
*/
@@ -609,7 +609,7 @@ public final Builder offset(Function<Time.Builder, ObjectBuilder<Time>> fn) {
609609
}
610610

611611
/**
612-
* The order of the returned buckets.
612+
* The sort order of the returned buckets.
613613
* <p>
614614
* API name: {@code order}
615615
* <p>
@@ -621,7 +621,7 @@ public final Builder order(List<NamedValue<SortOrder>> list) {
621621
}
622622

623623
/**
624-
* The order of the returned buckets.
624+
* The sort order of the returned buckets.
625625
* <p>
626626
* API name: {@code order}
627627
* <p>
@@ -680,7 +680,7 @@ public final Builder timeZone(@Nullable String value) {
680680

681681
/**
682682
* Set to <code>true</code> to associate a unique string key with each bucket
683-
* and returns the ranges as a hash rather than an array.
683+
* and return the ranges as a hash rather than an array.
684684
* <p>
685685
* API name: {@code keyed}
686686
*/

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateRangeExpression.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public static DateRangeExpression of(Function<Builder, ObjectBuilder<DateRangeEx
7272
}
7373

7474
/**
75-
* Start of the range.
75+
* Start of the range (inclusive).
7676
* <p>
7777
* API name: {@code from}
7878
*/
@@ -92,7 +92,7 @@ public final String key() {
9292
}
9393

9494
/**
95-
* End of the range.
95+
* End of the range (exclusive).
9696
* <p>
9797
* API name: {@code to}
9898
*/
@@ -154,7 +154,7 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder>
154154
private FieldDateMath to;
155155

156156
/**
157-
* Start of the range.
157+
* Start of the range (inclusive).
158158
* <p>
159159
* API name: {@code from}
160160
*/
@@ -164,7 +164,7 @@ public final Builder from(@Nullable FieldDateMath value) {
164164
}
165165

166166
/**
167-
* Start of the range.
167+
* Start of the range (inclusive).
168168
* <p>
169169
* API name: {@code from}
170170
*/
@@ -183,7 +183,7 @@ public final Builder key(@Nullable String value) {
183183
}
184184

185185
/**
186-
* End of the range.
186+
* End of the range (exclusive).
187187
* <p>
188188
* API name: {@code to}
189189
*/
@@ -193,7 +193,7 @@ public final Builder to(@Nullable FieldDateMath value) {
193193
}
194194

195195
/**
196-
* End of the range.
196+
* End of the range (exclusive).
197197
* <p>
198198
* API name: {@code to}
199199
*/

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ExtendedBounds.java

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,18 @@ public static <T> ExtendedBounds<T> of(Function<Builder<T>, ObjectBuilder<Extend
7373
}
7474

7575
/**
76-
* Required - API name: {@code max}
76+
* Required - Maximum value for the bound.
77+
* <p>
78+
* API name: {@code max}
7779
*/
7880
public final T max() {
7981
return this.max;
8082
}
8183

8284
/**
83-
* Required - API name: {@code min}
85+
* Required - Minimum value for the bound.
86+
* <p>
87+
* API name: {@code min}
8488
*/
8589
public final T min() {
8690
return this.min;
@@ -127,15 +131,19 @@ public static class Builder<T> extends WithJsonObjectBuilderBase<Builder<T>>
127131
private JsonpSerializer<T> tSerializer;
128132

129133
/**
130-
* Required - API name: {@code max}
134+
* Required - Maximum value for the bound.
135+
* <p>
136+
* API name: {@code max}
131137
*/
132138
public final Builder<T> max(T value) {
133139
this.max = value;
134140
return this;
135141
}
136142

137143
/**
138-
* Required - API name: {@code min}
144+
* Required - Minimum value for the bound.
145+
* <p>
146+
* API name: {@code min}
139147
*/
140148
public final Builder<T> min(T value) {
141149
this.min = value;

0 commit comments

Comments
 (0)