From 405e1d4e07dd61334b0cb58cce5f21fe8cddc7c8 Mon Sep 17 00:00:00 2001 From: Sylvain Wallez Date: Thu, 31 Aug 2023 10:45:15 +0200 Subject: [PATCH] [codegen] Update to latest API spec --- .../elasticsearch/_types/GeoDistanceType.java | 6 + .../_types/LatLonGeoLocation.java | 16 +- .../_types/aggregations/AggregationRange.java | 12 + .../aggregations/BoxplotAggregation.java | 12 +- .../CardinalityExecutionMode.java | 8 +- .../CategorizeTextAggregation.java | 8 +- .../aggregations/ChiSquareHeuristic.java | 22 +- .../DateHistogramAggregation.java | 10 +- .../aggregations/DateRangeExpression.java | 12 +- .../_types/aggregations/ExtendedBounds.java | 16 +- .../FrequentItemSetsAggregation.java | 8 +- .../aggregations/GeoBoundsAggregation.java | 6 + .../aggregations/GeoDistanceAggregation.java | 26 + .../aggregations/GeoHashGridAggregation.java | 35 + .../aggregations/GeoLineAggregation.java | 49 +- .../_types/aggregations/GeoLinePoint.java | 8 +- .../_types/aggregations/GeoLineSort.java | 10 +- .../aggregations/GeoTileGridAggregation.java | 32 + .../aggregations/GeohexGridAggregation.java | 8 +- .../GoogleNormalizedDistanceHeuristic.java | 6 + .../_types/aggregations/HdrMethod.java | 6 + .../aggregations/HistogramAggregation.java | 63 ++ .../aggregations/InferenceAggregation.java | 14 +- .../aggregations/IpPrefixAggregation.java | 14 +- .../aggregations/IpRangeAggregation.java | 12 + .../aggregations/IpRangeAggregationRange.java | 12 + .../aggregations/MatrixAggregation.java | 15 + .../aggregations/MatrixStatsAggregation.java | 4 + .../MedianAbsoluteDeviationAggregation.java | 8 + .../aggregations/MissingAggregation.java | 4 + .../MovingFunctionAggregation.java | 16 + .../MovingPercentilesAggregation.java | 12 + .../_types/aggregations/MultiTermLookup.java | 29 +- .../aggregations/MultiTermsAggregation.java | 55 +- .../MutualInformationHeuristic.java | 12 + .../aggregations/NestedAggregation.java | 4 + .../aggregations/NormalizeAggregation.java | 4 + .../_types/aggregations/NormalizeMethod.java | 24 + .../aggregations/ParentAggregation.java | 4 + .../PercentileRanksAggregation.java | 32 + .../aggregations/PercentilesAggregation.java | 32 + .../PercentilesBucketAggregation.java | 6 + .../aggregations/PipelineAggregationBase.java | 10 +- .../_types/aggregations/RangeAggregation.java | 24 + .../aggregations/RareTermsAggregation.java | 47 ++ .../_types/aggregations/RateAggregation.java | 10 + .../_types/aggregations/RateMode.java | 6 + .../ReverseNestedAggregation.java | 6 + .../aggregations/SamplerAggregation.java | 6 + .../ScriptedMetricAggregation.java | 57 ++ .../SerialDifferencingAggregation.java | 6 + .../SignificantTermsAggregation.java | 107 ++++ .../SignificantTextAggregation.java | 120 ++++ .../aggregations/StringStatsAggregation.java | 4 + .../_types/aggregations/TDigest.java | 8 + .../_types/aggregations/TTestAggregation.java | 16 + .../_types/aggregations/TTestType.java | 9 + .../_types/aggregations/TermsAggregation.java | 88 +++ .../TermsAggregationCollectMode.java | 8 + .../_types/aggregations/TermsPartition.java | 16 +- .../_types/aggregations/TestPopulation.java | 14 +- .../aggregations/TopHitsAggregation.java | 80 +++ .../aggregations/TopMetricsAggregation.java | 20 + .../_types/aggregations/TopMetricsValue.java | 8 +- .../VariableWidthHistogramAggregation.java | 22 + .../WeightedAverageAggregation.java | 16 + .../aggregations/WeightedAverageValue.java | 8 + .../_types/analysis/PatternTokenizer.java | 57 +- .../query_dsl/SimpleQueryStringFlag.java | 8 +- .../query_dsl/SimpleQueryStringFlags.java | 192 ------ .../SimpleQueryStringFlagsBuilders.java | 41 -- .../query_dsl/SimpleQueryStringQuery.java | 32 +- .../core/HealthReportResponse.java | 30 + .../elasticsearch/doc-files/api-spec.html | 412 ++++++------ .../elasticsearch/ingest/AppendProcessor.java | 26 +- .../ingest/AttachmentProcessor.java | 53 +- .../elasticsearch/ingest/BytesProcessor.java | 22 +- .../elasticsearch/ingest/CircleProcessor.java | 44 +- .../ingest/ConvertProcessor.java | 30 +- .../elasticsearch/ingest/CsvProcessor.java | 46 +- .../ingest/DateIndexNameProcessor.java | 50 +- .../elasticsearch/ingest/DateProcessor.java | 37 +- .../ingest/DeletePipelineRequest.java | 28 +- .../ingest/DissectProcessor.java | 28 +- .../ingest/DotExpanderProcessor.java | 18 +- .../ElasticsearchIngestAsyncClient.java | 8 +- .../ingest/ElasticsearchIngestClient.java | 8 +- .../elasticsearch/ingest/EnrichProcessor.java | 64 +- .../elasticsearch/ingest/FailProcessor.java | 10 +- .../ingest/ForeachProcessor.java | 26 +- .../elasticsearch/ingest/GeoIpProcessor.java | 43 +- .../ingest/GeoIpStatsRequest.java | 2 +- .../ingest/GetPipelineRequest.java | 20 +- .../elasticsearch/ingest/GrokProcessor.java | 51 +- .../elasticsearch/ingest/GsubProcessor.java | 38 +- .../ingest/InferenceConfigClassification.java | 24 + .../ingest/InferenceConfigRegression.java | 10 + .../ingest/InferenceProcessor.java | 32 +- .../elasticsearch/ingest/JoinProcessor.java | 22 +- .../elasticsearch/ingest/JsonProcessor.java | 40 +- .../ingest/KeyValueProcessor.java | 75 ++- .../ingest/LowercaseProcessor.java | 22 +- .../elasticsearch/ingest/Pipeline.java | 28 + .../ingest/PipelineProcessor.java | 12 +- .../elasticsearch/ingest/ProcessorBase.java | 26 + .../ingest/ProcessorGrokRequest.java | 5 +- .../ingest/PutPipelineRequest.java | 3 +- .../elasticsearch/ingest/RemoveProcessor.java | 20 +- .../elasticsearch/ingest/RenameProcessor.java | 22 +- .../elasticsearch/ingest/SetProcessor.java | 50 +- .../ingest/SetSecurityUserProcessor.java | 14 +- .../elasticsearch/ingest/SimulateRequest.java | 34 +- .../elasticsearch/ingest/SortProcessor.java | 20 +- .../elasticsearch/ingest/SplitProcessor.java | 34 +- .../elasticsearch/ingest/TrimProcessor.java | 20 +- .../ingest/UppercaseProcessor.java | 22 +- .../ingest/UrlDecodeProcessor.java | 22 +- .../ingest/UserAgentProcessor.java | 30 +- .../ingest/simulate/Document.java | 18 +- .../ingest/simulate/DocumentSimulation.java | 34 +- .../logstash/DeletePipelineRequest.java | 6 +- .../logstash/GetPipelineRequest.java | 8 +- .../elasticsearch/logstash/Pipeline.java | 66 +- .../logstash/PipelineSettings.java | 70 +- .../logstash/PutPipelineRequest.java | 6 +- .../elasticsearch/tasks/GetTasksResponse.java | 18 +- .../clients/elasticsearch/tasks/TaskInfo.java | 22 +- .../elasticsearch/tasks/TaskStatus.java | 600 ------------------ .../elasticsearch/model/UnionTests.java | 15 - .../clients/json/jackson/JsonEnumTest.java | 56 +- 130 files changed, 2951 insertions(+), 1387 deletions(-) delete mode 100644 java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlags.java delete mode 100644 java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlagsBuilders.java delete mode 100644 java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/TaskStatus.java diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/GeoDistanceType.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/GeoDistanceType.java index 43760fc33..1a7de8d2e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/GeoDistanceType.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/GeoDistanceType.java @@ -34,8 +34,14 @@ */ @JsonpDeserializable public enum GeoDistanceType implements JsonEnum { + /** + * The arc calculation is the most accurate. + */ Arc("arc"), + /** + * The plane calculation is faster but less accurate. + */ Plane("plane"), ; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/LatLonGeoLocation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/LatLonGeoLocation.java index cc25b3a89..f18133b26 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/LatLonGeoLocation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/LatLonGeoLocation.java @@ -65,14 +65,18 @@ public static LatLonGeoLocation of(Function + * API name: {@code lat} */ public final double lat() { return this.lat; } /** - * Required - API name: {@code lon} + * Required - Longitude + *

+ * API name: {@code lon} */ public final double lon() { return this.lon; @@ -114,7 +118,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Double lon; /** - * Required - API name: {@code lat} + * Required - Latitude + *

+ * API name: {@code lat} */ public final Builder lat(double value) { this.lat = value; @@ -122,7 +128,9 @@ public final Builder lat(double value) { } /** - * Required - API name: {@code lon} + * Required - Longitude + *

+ * API name: {@code lon} */ public final Builder lon(double value) { this.lon = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/AggregationRange.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/AggregationRange.java index 68e316f12..6a0c88104 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/AggregationRange.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/AggregationRange.java @@ -72,6 +72,8 @@ public static AggregationRange of(Function * API name: {@code from} */ @Nullable @@ -80,6 +82,8 @@ public final String from() { } /** + * Custom key to return the range with. + *

* API name: {@code key} */ @Nullable @@ -88,6 +92,8 @@ public final String key() { } /** + * End of the range (exclusive). + *

* API name: {@code to} */ @Nullable @@ -146,6 +152,8 @@ public static class Builder extends WithJsonObjectBuilderBase implement private String to; /** + * Start of the range (inclusive). + *

* API name: {@code from} */ public final Builder from(@Nullable String value) { @@ -154,6 +162,8 @@ public final Builder from(@Nullable String value) { } /** + * Custom key to return the range with. + *

* API name: {@code key} */ public final Builder key(@Nullable String value) { @@ -162,6 +172,8 @@ public final Builder key(@Nullable String value) { } /** + * End of the range (exclusive). + *

* API name: {@code to} */ public final Builder to(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/BoxplotAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/BoxplotAggregation.java index ce9cd542f..9ffa2ab3f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/BoxplotAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/BoxplotAggregation.java @@ -70,9 +70,9 @@ public Aggregation.Kind _aggregationKind() { } /** - * Controls memory usage and approximation error by limiting the maximum number - * of nodes used by the underlying TDigest algorithm to - * 20 * compression. + * Limits the maximum number of nodes used by the underlying TDigest algorithm + * to 20 * compression, enabling control of memory usage and + * approximation error. *

* API name: {@code compression} */ @@ -105,9 +105,9 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder20 * compression. + * Limits the maximum number of nodes used by the underlying TDigest algorithm + * to 20 * compression, enabling control of memory usage and + * approximation error. *

* API name: {@code compression} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CardinalityExecutionMode.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CardinalityExecutionMode.java index ecbbd8d52..5eee83d76 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CardinalityExecutionMode.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CardinalityExecutionMode.java @@ -36,19 +36,19 @@ @JsonpDeserializable public enum CardinalityExecutionMode implements JsonEnum { /** - * Run aggregation by using global ordinals of the field and resolving those + * Run the aggregation by using global ordinals of the field and resolving those * values after finishing a shard. */ GlobalOrdinals("global_ordinals"), /** - * Run aggregation by using segment ordinal values and resolving those values - * after each segment. + * Run the aggregation by using segment ordinal values and resolving those + * values after each segment. */ SegmentOrdinals("segment_ordinals"), /** - * Run aggregation by using field values directly. + * Run the aggregation by using field values directly. */ Direct("direct"), diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CategorizeTextAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CategorizeTextAggregation.java index d6bb05503..f284358cc 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CategorizeTextAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CategorizeTextAggregation.java @@ -214,7 +214,7 @@ public final Integer size() { } /** - * The minimum number of documents for a bucket to be returned to the results. + * The minimum number of documents in a bucket to be returned to the results. *

* API name: {@code min_doc_count} */ @@ -224,7 +224,7 @@ public final Integer minDocCount() { } /** - * The minimum number of documents for a bucket to be returned from the shard + * The minimum number of documents in a bucket to be returned from the shard * before merging. *

* API name: {@code shard_min_doc_count} @@ -475,7 +475,7 @@ public final Builder size(@Nullable Integer value) { } /** - * The minimum number of documents for a bucket to be returned to the results. + * The minimum number of documents in a bucket to be returned to the results. *

* API name: {@code min_doc_count} */ @@ -485,7 +485,7 @@ public final Builder minDocCount(@Nullable Integer value) { } /** - * The minimum number of documents for a bucket to be returned from the shard + * The minimum number of documents in a bucket to be returned from the shard * before merging. *

* API name: {@code shard_min_doc_count} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ChiSquareHeuristic.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ChiSquareHeuristic.java index a382cb31b..2b56755b5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ChiSquareHeuristic.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ChiSquareHeuristic.java @@ -67,14 +67,21 @@ public static ChiSquareHeuristic of(Functionfalse if you defined a custom background + * filter that represents a different set of documents that you want to compare + * to. + *

+ * API name: {@code background_is_superset} */ public final boolean backgroundIsSuperset() { return this.backgroundIsSuperset; } /** - * Required - API name: {@code include_negatives} + * Required - Set to false to filter out the terms that appear less + * often in the subset than in documents outside the subset. + *

+ * API name: {@code include_negatives} */ public final boolean includeNegatives() { return this.includeNegatives; @@ -118,7 +125,11 @@ public static class Builder extends WithJsonObjectBuilderBase private Boolean includeNegatives; /** - * Required - API name: {@code background_is_superset} + * Required - Set to false if you defined a custom background + * filter that represents a different set of documents that you want to compare + * to. + *

+ * API name: {@code background_is_superset} */ public final Builder backgroundIsSuperset(boolean value) { this.backgroundIsSuperset = value; @@ -126,7 +137,10 @@ public final Builder backgroundIsSuperset(boolean value) { } /** - * Required - API name: {@code include_negatives} + * Required - Set to false to filter out the terms that appear less + * often in the subset than in documents outside the subset. + *

+ * API name: {@code include_negatives} */ public final Builder includeNegatives(boolean value) { this.includeNegatives = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateHistogramAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateHistogramAggregation.java index 010ace33e..d45361554 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateHistogramAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateHistogramAggregation.java @@ -255,7 +255,7 @@ public final Time offset() { } /** - * The order of the returned buckets. + * The sort order of the returned buckets. *

* API name: {@code order} */ @@ -291,7 +291,7 @@ public final String timeZone() { /** * Set to true to associate a unique string key with each bucket - * and returns the ranges as a hash rather than an array. + * and return the ranges as a hash rather than an array. *

* API name: {@code keyed} */ @@ -609,7 +609,7 @@ public final Builder offset(Function> fn) { } /** - * The order of the returned buckets. + * The sort order of the returned buckets. *

* API name: {@code order} *

@@ -621,7 +621,7 @@ public final Builder order(List> list) { } /** - * The order of the returned buckets. + * The sort order of the returned buckets. *

* API name: {@code order} *

@@ -680,7 +680,7 @@ public final Builder timeZone(@Nullable String value) { /** * Set to true to associate a unique string key with each bucket - * and returns the ranges as a hash rather than an array. + * and return the ranges as a hash rather than an array. *

* API name: {@code keyed} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateRangeExpression.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateRangeExpression.java index d962e5534..af40b3541 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateRangeExpression.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateRangeExpression.java @@ -72,7 +72,7 @@ public static DateRangeExpression of(Function * API name: {@code from} */ @@ -92,7 +92,7 @@ public final String key() { } /** - * End of the range. + * End of the range (exclusive). *

* API name: {@code to} */ @@ -154,7 +154,7 @@ public static class Builder extends WithJsonObjectBuilderBase private FieldDateMath to; /** - * Start of the range. + * Start of the range (inclusive). *

* API name: {@code from} */ @@ -164,7 +164,7 @@ public final Builder from(@Nullable FieldDateMath value) { } /** - * Start of the range. + * Start of the range (inclusive). *

* API name: {@code from} */ @@ -183,7 +183,7 @@ public final Builder key(@Nullable String value) { } /** - * End of the range. + * End of the range (exclusive). *

* API name: {@code to} */ @@ -193,7 +193,7 @@ public final Builder to(@Nullable FieldDateMath value) { } /** - * End of the range. + * End of the range (exclusive). *

* API name: {@code to} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ExtendedBounds.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ExtendedBounds.java index 1b9735abb..cb1739631 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ExtendedBounds.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ExtendedBounds.java @@ -73,14 +73,18 @@ public static ExtendedBounds of(Function, ObjectBuilder + * API name: {@code max} */ public final T max() { return this.max; } /** - * Required - API name: {@code min} + * Required - Minimum value for the bound. + *

+ * API name: {@code min} */ public final T min() { return this.min; @@ -127,7 +131,9 @@ public static class Builder extends WithJsonObjectBuilderBase> private JsonpSerializer tSerializer; /** - * Required - API name: {@code max} + * Required - Maximum value for the bound. + *

+ * API name: {@code max} */ public final Builder max(T value) { this.max = value; @@ -135,7 +141,9 @@ public final Builder max(T value) { } /** - * Required - API name: {@code min} + * Required - Minimum value for the bound. + *

+ * API name: {@code min} */ public final Builder min(T value) { this.min = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/FrequentItemSetsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/FrequentItemSetsAggregation.java index bc657cd29..e9d9e2d1f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/FrequentItemSetsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/FrequentItemSetsAggregation.java @@ -91,7 +91,7 @@ public Aggregation.Kind _aggregationKind() { } /** - * Required - Fields to analyze + * Required - Fields to analyze. *

* API name: {@code fields} */ @@ -212,7 +212,7 @@ public static class Builder extends WithJsonObjectBuilderBase private Query filter; /** - * Required - Fields to analyze + * Required - Fields to analyze. *

* API name: {@code fields} *

@@ -224,7 +224,7 @@ public final Builder fields(List list) { } /** - * Required - Fields to analyze + * Required - Fields to analyze. *

* API name: {@code fields} *

@@ -236,7 +236,7 @@ public final Builder fields(FrequentItemSetsField value, FrequentItemSetsField.. } /** - * Required - Fields to analyze + * Required - Fields to analyze. *

* API name: {@code fields} *

diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoBoundsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoBoundsAggregation.java index 730316770..1fe4812d6 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoBoundsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoBoundsAggregation.java @@ -70,6 +70,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * Specifies whether the bounding box should be allowed to overlap the + * international date line. + *

* API name: {@code wrap_longitude} */ @Nullable @@ -101,6 +104,9 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder * API name: {@code wrap_longitude} */ public final Builder wrapLongitude(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoDistanceAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoDistanceAggregation.java index ab526fe4d..1f387e9e2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoDistanceAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoDistanceAggregation.java @@ -90,6 +90,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The distance calculation type. + *

* API name: {@code distance_type} */ @Nullable @@ -98,6 +100,8 @@ public final GeoDistanceType distanceType() { } /** + * A field of type geo_point used to evaluate the distance. + *

* API name: {@code field} */ @Nullable @@ -106,6 +110,8 @@ public final String field() { } /** + * The origin used to evaluate the distance. + *

* API name: {@code origin} */ @Nullable @@ -114,6 +120,8 @@ public final GeoLocation origin() { } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} */ public final List ranges() { @@ -121,6 +129,8 @@ public final List ranges() { } /** + * The distance unit. + *

* API name: {@code unit} */ @Nullable @@ -187,6 +197,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code distance_type} */ public final Builder distanceType(@Nullable GeoDistanceType value) { @@ -195,6 +207,8 @@ public final Builder distanceType(@Nullable GeoDistanceType value) { } /** + * A field of type geo_point used to evaluate the distance. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -203,6 +217,8 @@ public final Builder field(@Nullable String value) { } /** + * The origin used to evaluate the distance. + *

* API name: {@code origin} */ public final Builder origin(@Nullable GeoLocation value) { @@ -211,6 +227,8 @@ public final Builder origin(@Nullable GeoLocation value) { } /** + * The origin used to evaluate the distance. + *

* API name: {@code origin} */ public final Builder origin(Function> fn) { @@ -218,6 +236,8 @@ public final Builder origin(Function * API name: {@code ranges} *

* Adds all elements of list to ranges. @@ -228,6 +248,8 @@ public final Builder ranges(List list) { } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} *

* Adds one or more values to ranges. @@ -238,6 +260,8 @@ public final Builder ranges(AggregationRange value, AggregationRange... values) } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} *

* Adds a value to ranges using a builder lambda. @@ -247,6 +271,8 @@ public final Builder ranges(Function * API name: {@code unit} */ public final Builder unit(@Nullable DistanceUnit value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoHashGridAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoHashGridAggregation.java index d3f7384c4..4f8b43efa 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoHashGridAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoHashGridAggregation.java @@ -89,6 +89,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The bounding box to filter the points in each bucket. + *

* API name: {@code bounds} */ @Nullable @@ -97,6 +99,10 @@ public final GeoBounds bounds() { } /** + * Field containing indexed geo_point or geo_shape + * values. If the field contains an array, geohash_grid aggregates + * all array values. + *

* API name: {@code field} */ @Nullable @@ -105,6 +111,9 @@ public final String field() { } /** + * The string length of the geohashes used to define cells/buckets in the + * results. + *

* API name: {@code precision} */ @Nullable @@ -113,6 +122,10 @@ public final GeoHashPrecision precision() { } /** + * Allows for more accurate counting of the top cells returned in the final + * result the aggregation. Defaults to returning + * max(10,(size x number-of-shards)) buckets from each shard. + *

* API name: {@code shard_size} */ @Nullable @@ -121,6 +134,8 @@ public final Integer shardSize() { } /** + * The maximum number of geohash buckets to return. + *

* API name: {@code size} */ @Nullable @@ -184,6 +199,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code bounds} */ public final Builder bounds(@Nullable GeoBounds value) { @@ -192,6 +209,8 @@ public final Builder bounds(@Nullable GeoBounds value) { } /** + * The bounding box to filter the points in each bucket. + *

* API name: {@code bounds} */ public final Builder bounds(Function> fn) { @@ -199,6 +218,10 @@ public final Builder bounds(Function } /** + * Field containing indexed geo_point or geo_shape + * values. If the field contains an array, geohash_grid aggregates + * all array values. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -207,6 +230,9 @@ public final Builder field(@Nullable String value) { } /** + * The string length of the geohashes used to define cells/buckets in the + * results. + *

* API name: {@code precision} */ public final Builder precision(@Nullable GeoHashPrecision value) { @@ -215,6 +241,9 @@ public final Builder precision(@Nullable GeoHashPrecision value) { } /** + * The string length of the geohashes used to define cells/buckets in the + * results. + *

* API name: {@code precision} */ public final Builder precision(Function> fn) { @@ -222,6 +251,10 @@ public final Builder precision(Functionmax(10,(size x number-of-shards)) buckets from each shard. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -230,6 +263,8 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * The maximum number of geohash buckets to return. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineAggregation.java index 144a24f6b..39282bd1f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineAggregation.java @@ -89,20 +89,30 @@ public Aggregation.Kind _aggregationKind() { } /** - * Required - API name: {@code point} + * Required - The name of the geo_point field. + *

+ * API name: {@code point} */ public final GeoLinePoint point() { return this.point; } /** - * Required - API name: {@code sort} + * Required - The name of the numeric field to use as the sort key for ordering + * the points. When the geo_line aggregation is nested inside a + * time_series aggregation, this field defaults to + * @timestamp, and any other value will result in error. + *

+ * API name: {@code sort} */ public final GeoLineSort sort() { return this.sort; } /** + * When true, returns an additional array of the sort values in the + * feature properties. + *

* API name: {@code include_sort} */ @Nullable @@ -111,6 +121,8 @@ public final Boolean includeSort() { } /** + * The order in which the line is sorted (ascending or descending). + *

* API name: {@code sort_order} */ @Nullable @@ -119,6 +131,9 @@ public final SortOrder sortOrder() { } /** + * The maximum length of the line represented in the aggregation. Valid sizes + * are between 1 and 10000. + *

* API name: {@code size} */ @Nullable @@ -188,7 +203,9 @@ public static class Builder extends WithJsonObjectBuilderBase private Integer size; /** - * Required - API name: {@code point} + * Required - The name of the geo_point field. + *

+ * API name: {@code point} */ public final Builder point(GeoLinePoint value) { this.point = value; @@ -196,14 +213,21 @@ public final Builder point(GeoLinePoint value) { } /** - * Required - API name: {@code point} + * Required - The name of the geo_point field. + *

+ * API name: {@code point} */ public final Builder point(Function> fn) { return this.point(fn.apply(new GeoLinePoint.Builder()).build()); } /** - * Required - API name: {@code sort} + * Required - The name of the numeric field to use as the sort key for ordering + * the points. When the geo_line aggregation is nested inside a + * time_series aggregation, this field defaults to + * @timestamp, and any other value will result in error. + *

+ * API name: {@code sort} */ public final Builder sort(GeoLineSort value) { this.sort = value; @@ -211,13 +235,21 @@ public final Builder sort(GeoLineSort value) { } /** - * Required - API name: {@code sort} + * Required - The name of the numeric field to use as the sort key for ordering + * the points. When the geo_line aggregation is nested inside a + * time_series aggregation, this field defaults to + * @timestamp, and any other value will result in error. + *

+ * API name: {@code sort} */ public final Builder sort(Function> fn) { return this.sort(fn.apply(new GeoLineSort.Builder()).build()); } /** + * When true, returns an additional array of the sort values in the + * feature properties. + *

* API name: {@code include_sort} */ public final Builder includeSort(@Nullable Boolean value) { @@ -226,6 +258,8 @@ public final Builder includeSort(@Nullable Boolean value) { } /** + * The order in which the line is sorted (ascending or descending). + *

* API name: {@code sort_order} */ public final Builder sortOrder(@Nullable SortOrder value) { @@ -234,6 +268,9 @@ public final Builder sortOrder(@Nullable SortOrder value) { } /** + * The maximum length of the line represented in the aggregation. Valid sizes + * are between 1 and 10000. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLinePoint.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLinePoint.java index 9eb79106b..f01c32c45 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLinePoint.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLinePoint.java @@ -64,7 +64,9 @@ public static GeoLinePoint of(Function> fn) } /** - * Required - API name: {@code field} + * Required - The name of the geo_point field. + *

+ * API name: {@code field} */ public final String field() { return this.field; @@ -101,7 +103,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private String field; /** - * Required - API name: {@code field} + * Required - The name of the geo_point field. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineSort.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineSort.java index 6621b9c80..cffaa319b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineSort.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoLineSort.java @@ -64,7 +64,10 @@ public static GeoLineSort of(Function> fn) { } /** - * Required - API name: {@code field} + * Required - The name of the numeric field to use as the sort key for ordering + * the points. + *

+ * API name: {@code field} */ public final String field() { return this.field; @@ -101,7 +104,10 @@ public static class Builder extends WithJsonObjectBuilderBase implement private String field; /** - * Required - API name: {@code field} + * Required - The name of the numeric field to use as the sort key for ordering + * the points. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoTileGridAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoTileGridAggregation.java index 8c3ebdd8d..473d7ff4a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoTileGridAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeoTileGridAggregation.java @@ -99,6 +99,10 @@ public PivotGroupBy.Kind _pivotGroupByKind() { } /** + * Field containing indexed geo_point or geo_shape + * values. If the field contains an array, geotile_grid aggregates + * all array values. + *

* API name: {@code field} */ @Nullable @@ -107,6 +111,9 @@ public final String field() { } /** + * Integer zoom of the key used to define cells/buckets in the results. Values + * outside of the range [0,29] will be rejected. + *

* API name: {@code precision} */ @Nullable @@ -115,6 +122,10 @@ public final Number precision() { } /** + * Allows for more accurate counting of the top cells returned in the final + * result the aggregation. Defaults to returning + * max(10,(size x number-of-shards)) buckets from each shard. + *

* API name: {@code shard_size} */ @Nullable @@ -123,6 +134,8 @@ public final Integer shardSize() { } /** + * The maximum number of buckets to return. + *

* API name: {@code size} */ @Nullable @@ -131,6 +144,8 @@ public final Integer size() { } /** + * A bounding box to filter the geo-points or geo-shapes in each bucket. + *

* API name: {@code bounds} */ @Nullable @@ -194,6 +209,10 @@ public static class Builder extends BucketAggregationBase.AbstractBuildergeo_point or geo_shape + * values. If the field contains an array, geotile_grid aggregates + * all array values. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -202,6 +221,9 @@ public final Builder field(@Nullable String value) { } /** + * Integer zoom of the key used to define cells/buckets in the results. Values + * outside of the range [0,29] will be rejected. + *

* API name: {@code precision} */ public final Builder precision(@Nullable Number value) { @@ -210,6 +232,10 @@ public final Builder precision(@Nullable Number value) { } /** + * Allows for more accurate counting of the top cells returned in the final + * result the aggregation. Defaults to returning + * max(10,(size x number-of-shards)) buckets from each shard. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -218,6 +244,8 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * The maximum number of buckets to return. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { @@ -226,6 +254,8 @@ public final Builder size(@Nullable Integer value) { } /** + * A bounding box to filter the geo-points or geo-shapes in each bucket. + *

* API name: {@code bounds} */ public final Builder bounds(@Nullable GeoBounds value) { @@ -234,6 +264,8 @@ public final Builder bounds(@Nullable GeoBounds value) { } /** + * A bounding box to filter the geo-points or geo-shapes in each bucket. + *

* API name: {@code bounds} */ public final Builder bounds(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeohexGridAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeohexGridAggregation.java index 2f5214cdd..ceed32415 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeohexGridAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GeohexGridAggregation.java @@ -88,8 +88,8 @@ public Aggregation.Kind _aggregationKind() { } /** - * Required - Field containing indexed geo-point values. Must be explicitly - * mapped as a geo_point field. If the field contains an array + * Required - Field containing indexed geo_point or + * geo_shape values. If the field contains an array, * geohex_grid aggregates all array values. *

* API name: {@code field} @@ -192,8 +192,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuildergeo_point field. If the field contains an array + * Required - Field containing indexed geo_point or + * geo_shape values. If the field contains an array, * geohex_grid aggregates all array values. *

* API name: {@code field} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GoogleNormalizedDistanceHeuristic.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GoogleNormalizedDistanceHeuristic.java index 4fbe57d63..d97d414d5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GoogleNormalizedDistanceHeuristic.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/GoogleNormalizedDistanceHeuristic.java @@ -65,6 +65,9 @@ public static GoogleNormalizedDistanceHeuristic of( } /** + * Set to false if you defined a custom background filter that + * represents a different set of documents that you want to compare to. + *

* API name: {@code background_is_superset} */ @Nullable @@ -109,6 +112,9 @@ public static class Builder extends WithJsonObjectBuilderBase private Boolean backgroundIsSuperset; /** + * Set to false if you defined a custom background filter that + * represents a different set of documents that you want to compare to. + *

* API name: {@code background_is_superset} */ public final Builder backgroundIsSuperset(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HdrMethod.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HdrMethod.java index 878bac5fd..f13601aed 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HdrMethod.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HdrMethod.java @@ -64,6 +64,9 @@ public static HdrMethod of(Function> fn) { } /** + * Specifies the resolution of values for the histogram in number of significant + * digits. + *

* API name: {@code number_of_significant_value_digits} */ @Nullable @@ -106,6 +109,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Integer numberOfSignificantValueDigits; /** + * Specifies the resolution of values for the histogram in number of significant + * digits. + *

* API name: {@code number_of_significant_value_digits} */ public final Builder numberOfSignificantValueDigits(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HistogramAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HistogramAggregation.java index 959cf5604..69253f8f4 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HistogramAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/HistogramAggregation.java @@ -127,6 +127,8 @@ public PivotGroupBy.Kind _pivotGroupByKind() { } /** + * Enables extending the bounds of the histogram beyond the data itself. + *

* API name: {@code extended_bounds} */ @Nullable @@ -135,6 +137,10 @@ public final ExtendedBounds extendedBounds() { } /** + * Limits the range of buckets in the histogram. It is particularly useful in + * the case of open data ranges that can result in a very large number of + * buckets. + *

* API name: {@code hard_bounds} */ @Nullable @@ -143,6 +149,8 @@ public final ExtendedBounds hardBounds() { } /** + * The name of the field to aggregate on. + *

* API name: {@code field} */ @Nullable @@ -151,6 +159,8 @@ public final String field() { } /** + * The interval for the buckets. Must be a positive decimal. + *

* API name: {@code interval} */ @Nullable @@ -159,6 +169,10 @@ public final Double interval() { } /** + * Only returns buckets that have min_doc_count number of + * documents. By default, the response will fill gaps in the histogram with + * empty buckets. + *

* API name: {@code min_doc_count} */ @Nullable @@ -167,6 +181,9 @@ public final Integer minDocCount() { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ @Nullable @@ -175,6 +192,10 @@ public final Double missing() { } /** + * By default, the bucket keys start with 0 and then continue in even spaced + * steps of interval. The bucket boundaries can be shifted by using + * the offset option. + *

* API name: {@code offset} */ @Nullable @@ -183,6 +204,9 @@ public final Double offset() { } /** + * The sort order of the returned buckets. By default, the returned buckets are + * sorted by their key ascending. + *

* API name: {@code order} */ public final List> order() { @@ -206,6 +230,9 @@ public final String format() { } /** + * If true, returns buckets as a hash instead of an array, keyed by + * the bucket keys. + *

* API name: {@code keyed} */ @Nullable @@ -325,6 +352,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code extended_bounds} */ public final Builder extendedBounds(@Nullable ExtendedBounds value) { @@ -333,6 +362,8 @@ public final Builder extendedBounds(@Nullable ExtendedBounds value) { } /** + * Enables extending the bounds of the histogram beyond the data itself. + *

* API name: {@code extended_bounds} */ public final Builder extendedBounds( @@ -341,6 +372,10 @@ public final Builder extendedBounds( } /** + * Limits the range of buckets in the histogram. It is particularly useful in + * the case of open data ranges that can result in a very large number of + * buckets. + *

* API name: {@code hard_bounds} */ public final Builder hardBounds(@Nullable ExtendedBounds value) { @@ -349,6 +384,10 @@ public final Builder hardBounds(@Nullable ExtendedBounds value) { } /** + * Limits the range of buckets in the histogram. It is particularly useful in + * the case of open data ranges that can result in a very large number of + * buckets. + *

* API name: {@code hard_bounds} */ public final Builder hardBounds( @@ -357,6 +396,8 @@ public final Builder hardBounds( } /** + * The name of the field to aggregate on. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -365,6 +406,8 @@ public final Builder field(@Nullable String value) { } /** + * The interval for the buckets. Must be a positive decimal. + *

* API name: {@code interval} */ public final Builder interval(@Nullable Double value) { @@ -373,6 +416,10 @@ public final Builder interval(@Nullable Double value) { } /** + * Only returns buckets that have min_doc_count number of + * documents. By default, the response will fill gaps in the histogram with + * empty buckets. + *

* API name: {@code min_doc_count} */ public final Builder minDocCount(@Nullable Integer value) { @@ -381,6 +428,9 @@ public final Builder minDocCount(@Nullable Integer value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(@Nullable Double value) { @@ -389,6 +439,10 @@ public final Builder missing(@Nullable Double value) { } /** + * By default, the bucket keys start with 0 and then continue in even spaced + * steps of interval. The bucket boundaries can be shifted by using + * the offset option. + *

* API name: {@code offset} */ public final Builder offset(@Nullable Double value) { @@ -397,6 +451,9 @@ public final Builder offset(@Nullable Double value) { } /** + * The sort order of the returned buckets. By default, the returned buckets are + * sorted by their key ascending. + *

* API name: {@code order} *

* Adds all elements of list to order. @@ -407,6 +464,9 @@ public final Builder order(List> list) { } /** + * The sort order of the returned buckets. By default, the returned buckets are + * sorted by their key ascending. + *

* API name: {@code order} *

* Adds one or more values to order. @@ -440,6 +500,9 @@ public final Builder format(@Nullable String value) { } /** + * If true, returns buckets as a hash instead of an array, keyed by + * the bucket keys. + *

* API name: {@code keyed} */ public final Builder keyed(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/InferenceAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/InferenceAggregation.java index 21be616ee..fa15205bf 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/InferenceAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/InferenceAggregation.java @@ -74,13 +74,17 @@ public Aggregation.Kind _aggregationKind() { } /** - * Required - API name: {@code model_id} + * Required - The ID or alias for the trained model. + *

+ * API name: {@code model_id} */ public final String modelId() { return this.modelId; } /** + * Contains the inference type and its options. + *

* API name: {@code inference_config} */ @Nullable @@ -117,7 +121,9 @@ public static class Builder extends PipelineAggregationBase.AbstractBuilder + * API name: {@code model_id} */ public final Builder modelId(String value) { this.modelId = value; @@ -125,6 +131,8 @@ public final Builder modelId(String value) { } /** + * Contains the inference type and its options. + *

* API name: {@code inference_config} */ public final Builder inferenceConfig(@Nullable InferenceConfig value) { @@ -133,6 +141,8 @@ public final Builder inferenceConfig(@Nullable InferenceConfig value) { } /** + * Contains the inference type and its options. + *

* API name: {@code inference_config} */ public final Builder inferenceConfig(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpPrefixAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpPrefixAggregation.java index 2cc119ebf..ca553cbff 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpPrefixAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpPrefixAggregation.java @@ -92,8 +92,8 @@ public Aggregation.Kind _aggregationKind() { } /** - * Required - The document IP address field to aggregation on. The field mapping - * type must be ip + * Required - The IP address field to aggregation on. The field mapping type + * must be ip. *

* API name: {@code field} */ @@ -144,7 +144,8 @@ public final Boolean keyed() { } /** - * Minimum number of documents for buckets to be included in the response. + * Minimum number of documents in a bucket for it to be included in the + * response. *

* API name: {@code min_doc_count} */ @@ -211,8 +212,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilderip + * Required - The IP address field to aggregation on. The field mapping type + * must be ip. *

* API name: {@code field} */ @@ -265,7 +266,8 @@ public final Builder keyed(@Nullable Boolean value) { } /** - * Minimum number of documents for buckets to be included in the response. + * Minimum number of documents in a bucket for it to be included in the + * response. *

* API name: {@code min_doc_count} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregation.java index 7967d1ff6..1984f18e1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregation.java @@ -75,6 +75,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The date field whose values are used to build ranges. + *

* API name: {@code field} */ @Nullable @@ -83,6 +85,8 @@ public final String field() { } /** + * Array of IP ranges. + *

* API name: {@code ranges} */ public final List ranges() { @@ -126,6 +130,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder ranges; /** + * The date field whose values are used to build ranges. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -134,6 +140,8 @@ public final Builder field(@Nullable String value) { } /** + * Array of IP ranges. + *

* API name: {@code ranges} *

* Adds all elements of list to ranges. @@ -144,6 +152,8 @@ public final Builder ranges(List list) { } /** + * Array of IP ranges. + *

* API name: {@code ranges} *

* Adds one or more values to ranges. @@ -154,6 +164,8 @@ public final Builder ranges(IpRangeAggregationRange value, IpRangeAggregationRan } /** + * Array of IP ranges. + *

* API name: {@code ranges} *

* Adds a value to ranges using a builder lambda. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregationRange.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregationRange.java index b221ec553..58eac9c0f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregationRange.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/IpRangeAggregationRange.java @@ -72,6 +72,8 @@ public static IpRangeAggregationRange of(Function * API name: {@code from} */ @Nullable @@ -80,6 +82,8 @@ public final String from() { } /** + * IP range defined as a CIDR mask. + *

* API name: {@code mask} */ @Nullable @@ -88,6 +92,8 @@ public final String mask() { } /** + * End of the range. + *

* API name: {@code to} */ @Nullable @@ -148,6 +154,8 @@ public static class Builder extends WithJsonObjectBuilderBase private String to; /** + * Start of the range. + *

* API name: {@code from} */ public final Builder from(@Nullable String value) { @@ -156,6 +164,8 @@ public final Builder from(@Nullable String value) { } /** + * IP range defined as a CIDR mask. + *

* API name: {@code mask} */ public final Builder mask(@Nullable String value) { @@ -164,6 +174,8 @@ public final Builder mask(@Nullable String value) { } /** + * End of the range. + *

* API name: {@code to} */ public final Builder to(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixAggregation.java index 91b936257..8c4bd262f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixAggregation.java @@ -64,6 +64,8 @@ protected MatrixAggregation(AbstractBuilder builder) { } /** + * An array of fields for computing the statistics. + *

* API name: {@code fields} */ public final List fields() { @@ -71,6 +73,9 @@ public final List fields() { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Map missing() { @@ -114,6 +119,8 @@ public abstract static class AbstractBuilder missing; /** + * An array of fields for computing the statistics. + *

* API name: {@code fields} *

* Adds all elements of list to fields. @@ -124,6 +131,8 @@ public final BuilderT fields(List list) { } /** + * An array of fields for computing the statistics. + *

* API name: {@code fields} *

* Adds one or more values to fields. @@ -134,6 +143,9 @@ public final BuilderT fields(String value, String... values) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} *

* Adds all entries of map to missing. @@ -144,6 +156,9 @@ public final BuilderT missing(Map map) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} *

* Adds an entry to missing. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixStatsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixStatsAggregation.java index 98c30470c..185f5ac59 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixStatsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MatrixStatsAggregation.java @@ -70,6 +70,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * Array value the aggregation will use for array or multi-valued fields. + *

* API name: {@code mode} */ @Nullable @@ -100,6 +102,8 @@ public static class Builder extends MatrixAggregation.AbstractBuilder private SortMode mode; /** + * Array value the aggregation will use for array or multi-valued fields. + *

* API name: {@code mode} */ public final Builder mode(@Nullable SortMode value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MedianAbsoluteDeviationAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MedianAbsoluteDeviationAggregation.java index a480f2744..271f51a06 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MedianAbsoluteDeviationAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MedianAbsoluteDeviationAggregation.java @@ -71,6 +71,10 @@ public Aggregation.Kind _aggregationKind() { } /** + * Limits the maximum number of nodes used by the underlying TDigest algorithm + * to 20 * compression, enabling control of memory usage and + * approximation error. + *

* API name: {@code compression} */ @Nullable @@ -102,6 +106,10 @@ public static class Builder extends FormatMetricAggregationBase.AbstractBuilder< private Double compression; /** + * Limits the maximum number of nodes used by the underlying TDigest algorithm + * to 20 * compression, enabling control of memory usage and + * approximation error. + *

* API name: {@code compression} */ public final Builder compression(@Nullable Double value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MissingAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MissingAggregation.java index fb7ede585..9488d4c67 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MissingAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MissingAggregation.java @@ -75,6 +75,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The name of the field. + *

* API name: {@code field} */ @Nullable @@ -122,6 +124,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code field} */ public final Builder field(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingFunctionAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingFunctionAggregation.java index 0c2de9ae4..fcd973b9f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingFunctionAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingFunctionAggregation.java @@ -79,6 +79,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The script that should be executed on each window of data. + *

* API name: {@code script} */ @Nullable @@ -87,6 +89,10 @@ public final String script() { } /** + * By default, the window consists of the last n values excluding the current + * bucket. Increasing shift by 1, moves the starting window + * position by 1 to the right. + *

* API name: {@code shift} */ @Nullable @@ -95,6 +101,8 @@ public final Integer shift() { } /** + * The size of window to "slide" across the histogram. + *

* API name: {@code window} */ @Nullable @@ -142,6 +150,8 @@ public static class Builder extends PipelineAggregationBase.AbstractBuilder * API name: {@code script} */ public final Builder script(@Nullable String value) { @@ -150,6 +160,10 @@ public final Builder script(@Nullable String value) { } /** + * By default, the window consists of the last n values excluding the current + * bucket. Increasing shift by 1, moves the starting window + * position by 1 to the right. + *

* API name: {@code shift} */ public final Builder shift(@Nullable Integer value) { @@ -158,6 +172,8 @@ public final Builder shift(@Nullable Integer value) { } /** + * The size of window to "slide" across the histogram. + *

* API name: {@code window} */ public final Builder window(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingPercentilesAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingPercentilesAggregation.java index 1a771c503..b314e5cfd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingPercentilesAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MovingPercentilesAggregation.java @@ -79,6 +79,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The size of window to "slide" across the histogram. + *

* API name: {@code window} */ @Nullable @@ -87,6 +89,10 @@ public final Integer window() { } /** + * By default, the window consists of the last n values excluding the current + * bucket. Increasing shift by 1, moves the starting window + * position by 1 to the right. + *

* API name: {@code shift} */ @Nullable @@ -142,6 +148,8 @@ public static class Builder extends PipelineAggregationBase.AbstractBuilder * API name: {@code window} */ public final Builder window(@Nullable Integer value) { @@ -150,6 +158,10 @@ public final Builder window(@Nullable Integer value) { } /** + * By default, the window consists of the last n values excluding the current + * bucket. Increasing shift by 1, moves the starting window + * position by 1 to the right. + *

* API name: {@code shift} */ public final Builder shift(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermLookup.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermLookup.java index fe461a335..435ab2e14 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermLookup.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermLookup.java @@ -69,13 +69,18 @@ public static MultiTermLookup of(Function + * API name: {@code field} */ public final String field() { return this.field; } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ @Nullable @@ -123,7 +128,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private FieldValue missing; /** - * Required - API name: {@code field} + * Required - A fields from which to retrieve terms. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -131,6 +138,9 @@ public final Builder field(String value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(@Nullable FieldValue value) { @@ -139,6 +149,9 @@ public final Builder missing(@Nullable FieldValue value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(Function> fn) { @@ -146,6 +159,9 @@ public final Builder missing(Function * API name: {@code missing} */ public final Builder missing(String value) { @@ -154,6 +170,9 @@ public final Builder missing(String value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(long value) { @@ -162,6 +181,9 @@ public final Builder missing(long value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(double value) { @@ -170,6 +192,9 @@ public final Builder missing(double value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermsAggregation.java index d2c10f31f..fee40e93a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MultiTermsAggregation.java @@ -102,6 +102,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * Specifies the strategy for data collection. + *

* API name: {@code collect_mode} */ @Nullable @@ -110,6 +112,9 @@ public final TermsAggregationCollectMode collectMode() { } /** + * Specifies the sort order of the buckets. Defaults to sorting by descending + * document count. + *

* API name: {@code order} */ public final List> order() { @@ -117,6 +122,8 @@ public final List> order() { } /** + * The minimum number of documents in a bucket for it to be returned. + *

* API name: {@code min_doc_count} */ @Nullable @@ -125,6 +132,9 @@ public final Long minDocCount() { } /** + * The minimum number of documents in a bucket on each shard for it to be + * returned. + *

* API name: {@code shard_min_doc_count} */ @Nullable @@ -133,6 +143,10 @@ public final Long shardMinDocCount() { } /** + * The number of candidate terms produced by each shard. By default, + * shard_size will be automatically estimated based on the number + * of shards and the size parameter. + *

* API name: {@code shard_size} */ @Nullable @@ -141,6 +155,8 @@ public final Integer shardSize() { } /** + * Calculates the doc count error on per term basis. + *

* API name: {@code show_term_doc_count_error} */ @Nullable @@ -149,6 +165,8 @@ public final Boolean showTermDocCountError() { } /** + * The number of term buckets should be returned out of the overall terms list. + *

* API name: {@code size} */ @Nullable @@ -157,7 +175,9 @@ public final Integer size() { } /** - * Required - API name: {@code terms} + * Required - The field from which to generate sets of terms. + *

+ * API name: {@code terms} */ public final List terms() { return this.terms; @@ -254,6 +274,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder terms; /** + * Specifies the strategy for data collection. + *

* API name: {@code collect_mode} */ public final Builder collectMode(@Nullable TermsAggregationCollectMode value) { @@ -262,6 +284,9 @@ public final Builder collectMode(@Nullable TermsAggregationCollectMode value) { } /** + * Specifies the sort order of the buckets. Defaults to sorting by descending + * document count. + *

* API name: {@code order} *

* Adds all elements of list to order. @@ -272,6 +297,9 @@ public final Builder order(List> list) { } /** + * Specifies the sort order of the buckets. Defaults to sorting by descending + * document count. + *

* API name: {@code order} *

* Adds one or more values to order. @@ -282,6 +310,8 @@ public final Builder order(NamedValue value, NamedValue... } /** + * The minimum number of documents in a bucket for it to be returned. + *

* API name: {@code min_doc_count} */ public final Builder minDocCount(@Nullable Long value) { @@ -290,6 +320,9 @@ public final Builder minDocCount(@Nullable Long value) { } /** + * The minimum number of documents in a bucket on each shard for it to be + * returned. + *

* API name: {@code shard_min_doc_count} */ public final Builder shardMinDocCount(@Nullable Long value) { @@ -298,6 +331,10 @@ public final Builder shardMinDocCount(@Nullable Long value) { } /** + * The number of candidate terms produced by each shard. By default, + * shard_size will be automatically estimated based on the number + * of shards and the size parameter. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -306,6 +343,8 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * Calculates the doc count error on per term basis. + *

* API name: {@code show_term_doc_count_error} */ public final Builder showTermDocCountError(@Nullable Boolean value) { @@ -314,6 +353,8 @@ public final Builder showTermDocCountError(@Nullable Boolean value) { } /** + * The number of term buckets should be returned out of the overall terms list. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { @@ -322,7 +363,9 @@ public final Builder size(@Nullable Integer value) { } /** - * Required - API name: {@code terms} + * Required - The field from which to generate sets of terms. + *

+ * API name: {@code terms} *

* Adds all elements of list to terms. */ @@ -332,7 +375,9 @@ public final Builder terms(List list) { } /** - * Required - API name: {@code terms} + * Required - The field from which to generate sets of terms. + *

+ * API name: {@code terms} *

* Adds one or more values to terms. */ @@ -342,7 +387,9 @@ public final Builder terms(MultiTermLookup value, MultiTermLookup... values) { } /** - * Required - API name: {@code terms} + * Required - The field from which to generate sets of terms. + *

+ * API name: {@code terms} *

* Adds a value to terms using a builder lambda. */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MutualInformationHeuristic.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MutualInformationHeuristic.java index be6b58cd7..f23d8b773 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MutualInformationHeuristic.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/MutualInformationHeuristic.java @@ -68,6 +68,9 @@ public static MutualInformationHeuristic of(Functionfalse if you defined a custom background filter that + * represents a different set of documents that you want to compare to. + *

* API name: {@code background_is_superset} */ @Nullable @@ -76,6 +79,9 @@ public final Boolean backgroundIsSuperset() { } /** + * Set to false to filter out the terms that appear less often in + * the subset than in documents outside the subset. + *

* API name: {@code include_negatives} */ @Nullable @@ -128,6 +134,9 @@ public static class Builder extends WithJsonObjectBuilderBase private Boolean includeNegatives; /** + * Set to false if you defined a custom background filter that + * represents a different set of documents that you want to compare to. + *

* API name: {@code background_is_superset} */ public final Builder backgroundIsSuperset(@Nullable Boolean value) { @@ -136,6 +145,9 @@ public final Builder backgroundIsSuperset(@Nullable Boolean value) { } /** + * Set to false to filter out the terms that appear less often in + * the subset than in documents outside the subset. + *

* API name: {@code include_negatives} */ public final Builder includeNegatives(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NestedAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NestedAggregation.java index f46df35a2..f05ffea34 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NestedAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NestedAggregation.java @@ -70,6 +70,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The path to the field of type nested. + *

* API name: {@code path} */ @Nullable @@ -101,6 +103,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuildernested. + *

* API name: {@code path} */ public final Builder path(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeAggregation.java index a8fc46c48..c0321f6e4 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeAggregation.java @@ -69,6 +69,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The specific method to apply. + *

* API name: {@code method} */ @Nullable @@ -99,6 +101,8 @@ public static class Builder extends PipelineAggregationBase.AbstractBuilder * API name: {@code method} */ public final Builder method(@Nullable NormalizeMethod value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeMethod.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeMethod.java index 47dd5e402..2f666a1e8 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeMethod.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/NormalizeMethod.java @@ -35,16 +35,40 @@ */ @JsonpDeserializable public enum NormalizeMethod implements JsonEnum { + /** + * This method rescales the data such that the minimum number is 0, and the + * maximum number is 1, with the rest normalized linearly in-between. + */ Rescale_0_1("rescale_0_1"), + /** + * This method rescales the data such that the minimum number is 0, and the + * maximum number is 100, with the rest normalized linearly in-between. + */ Rescale_0_100("rescale_0_100"), + /** + * This method normalizes each value so that it represents a percentage of the + * total sum it attributes to. + */ PercentOfSum("percent_of_sum"), + /** + * This method normalizes such that each value is normalized by how much it + * differs from the average. + */ Mean("mean"), + /** + * This method normalizes such that each value represents how far it is from the + * mean relative to the standard deviation. + */ ZScore("z-score"), + /** + * This method normalizes such that each value is exponentiated and relative to + * the sum of the exponents of the original values. + */ Softmax("softmax"), ; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ParentAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ParentAggregation.java index 7d69bf15e..739c4c6a2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ParentAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ParentAggregation.java @@ -70,6 +70,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The child type that should be selected. + *

* API name: {@code type} */ @Nullable @@ -101,6 +103,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code type} */ public final Builder type(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentileRanksAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentileRanksAggregation.java index 74139fbb4..7837dce1c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentileRanksAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentileRanksAggregation.java @@ -84,6 +84,10 @@ public Aggregation.Kind _aggregationKind() { } /** + * By default, the aggregation associates a unique string key with each bucket + * and returns the ranges as a hash rather than an array. Set to + * false to disable this behavior. + *

* API name: {@code keyed} */ @Nullable @@ -92,6 +96,8 @@ public final Boolean keyed() { } /** + * An array of values for which to calculate the percentile ranks. + *

* API name: {@code values} */ public final List values() { @@ -99,6 +105,9 @@ public final List values() { } /** + * Uses the alternative High Dynamic Range Histogram algorithm to calculate + * percentile ranks. + *

* API name: {@code hdr} */ @Nullable @@ -107,6 +116,9 @@ public final HdrMethod hdr() { } /** + * Sets parameters for the default TDigest algorithm used to calculate + * percentile ranks. + *

* API name: {@code tdigest} */ @Nullable @@ -167,6 +179,10 @@ public static class Builder extends FormatMetricAggregationBase.AbstractBuilder< private TDigest tdigest; /** + * By default, the aggregation associates a unique string key with each bucket + * and returns the ranges as a hash rather than an array. Set to + * false to disable this behavior. + *

* API name: {@code keyed} */ public final Builder keyed(@Nullable Boolean value) { @@ -175,6 +191,8 @@ public final Builder keyed(@Nullable Boolean value) { } /** + * An array of values for which to calculate the percentile ranks. + *

* API name: {@code values} *

* Adds all elements of list to values. @@ -185,6 +203,8 @@ public final Builder values(List list) { } /** + * An array of values for which to calculate the percentile ranks. + *

* API name: {@code values} *

* Adds one or more values to values. @@ -195,6 +215,9 @@ public final Builder values(Double value, Double... values) { } /** + * Uses the alternative High Dynamic Range Histogram algorithm to calculate + * percentile ranks. + *

* API name: {@code hdr} */ public final Builder hdr(@Nullable HdrMethod value) { @@ -203,6 +226,9 @@ public final Builder hdr(@Nullable HdrMethod value) { } /** + * Uses the alternative High Dynamic Range Histogram algorithm to calculate + * percentile ranks. + *

* API name: {@code hdr} */ public final Builder hdr(Function> fn) { @@ -210,6 +236,9 @@ public final Builder hdr(Function> f } /** + * Sets parameters for the default TDigest algorithm used to calculate + * percentile ranks. + *

* API name: {@code tdigest} */ public final Builder tdigest(@Nullable TDigest value) { @@ -218,6 +247,9 @@ public final Builder tdigest(@Nullable TDigest value) { } /** + * Sets parameters for the default TDigest algorithm used to calculate + * percentile ranks. + *

* API name: {@code tdigest} */ public final Builder tdigest(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesAggregation.java index 0262c0f35..b85ef2f0a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesAggregation.java @@ -84,6 +84,10 @@ public Aggregation.Kind _aggregationKind() { } /** + * By default, the aggregation associates a unique string key with each bucket + * and returns the ranges as a hash rather than an array. Set to + * false to disable this behavior. + *

* API name: {@code keyed} */ @Nullable @@ -92,6 +96,8 @@ public final Boolean keyed() { } /** + * The percentiles to calculate. + *

* API name: {@code percents} */ public final List percents() { @@ -99,6 +105,9 @@ public final List percents() { } /** + * Uses the alternative High Dynamic Range Histogram algorithm to calculate + * percentiles. + *

* API name: {@code hdr} */ @Nullable @@ -107,6 +116,9 @@ public final HdrMethod hdr() { } /** + * Sets parameters for the default TDigest algorithm used to calculate + * percentiles. + *

* API name: {@code tdigest} */ @Nullable @@ -167,6 +179,10 @@ public static class Builder extends FormatMetricAggregationBase.AbstractBuilder< private TDigest tdigest; /** + * By default, the aggregation associates a unique string key with each bucket + * and returns the ranges as a hash rather than an array. Set to + * false to disable this behavior. + *

* API name: {@code keyed} */ public final Builder keyed(@Nullable Boolean value) { @@ -175,6 +191,8 @@ public final Builder keyed(@Nullable Boolean value) { } /** + * The percentiles to calculate. + *

* API name: {@code percents} *

* Adds all elements of list to percents. @@ -185,6 +203,8 @@ public final Builder percents(List list) { } /** + * The percentiles to calculate. + *

* API name: {@code percents} *

* Adds one or more values to percents. @@ -195,6 +215,9 @@ public final Builder percents(Double value, Double... values) { } /** + * Uses the alternative High Dynamic Range Histogram algorithm to calculate + * percentiles. + *

* API name: {@code hdr} */ public final Builder hdr(@Nullable HdrMethod value) { @@ -203,6 +226,9 @@ public final Builder hdr(@Nullable HdrMethod value) { } /** + * Uses the alternative High Dynamic Range Histogram algorithm to calculate + * percentiles. + *

* API name: {@code hdr} */ public final Builder hdr(Function> fn) { @@ -210,6 +236,9 @@ public final Builder hdr(Function> f } /** + * Sets parameters for the default TDigest algorithm used to calculate + * percentiles. + *

* API name: {@code tdigest} */ public final Builder tdigest(@Nullable TDigest value) { @@ -218,6 +247,9 @@ public final Builder tdigest(@Nullable TDigest value) { } /** + * Sets parameters for the default TDigest algorithm used to calculate + * percentiles. + *

* API name: {@code tdigest} */ public final Builder tdigest(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesBucketAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesBucketAggregation.java index 46c8f5d52..6aee9fab0 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesBucketAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PercentilesBucketAggregation.java @@ -71,6 +71,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The list of percentiles to calculate. + *

* API name: {@code percents} */ public final List percents() { @@ -106,6 +108,8 @@ public static class Builder extends PipelineAggregationBase.AbstractBuilder percents; /** + * The list of percentiles to calculate. + *

* API name: {@code percents} *

* Adds all elements of list to percents. @@ -116,6 +120,8 @@ public final Builder percents(List list) { } /** + * The list of percentiles to calculate. + *

* API name: {@code percents} *

* Adds one or more values to percents. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PipelineAggregationBase.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PipelineAggregationBase.java index 263fbf84d..ba0bd3d20 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PipelineAggregationBase.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/PipelineAggregationBase.java @@ -62,8 +62,9 @@ protected PipelineAggregationBase(AbstractBuilder builder) { } /** - * DecimalFormat pattern for the output value. If specified, the formatted value - * is returned in the aggregation’s value_as_string property. + * DecimalFormat pattern for the output value. If specified, the + * formatted value is returned in the aggregation’s value_as_string + * property. *

* API name: {@code format} */ @@ -107,8 +108,9 @@ public abstract static class AbstractBuildervalue_as_string property. + * DecimalFormat pattern for the output value. If specified, the + * formatted value is returned in the aggregation’s value_as_string + * property. *

* API name: {@code format} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RangeAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RangeAggregation.java index 63f136986..b1f2a8a59 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RangeAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RangeAggregation.java @@ -94,6 +94,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The date field whose values are use to build ranges. + *

* API name: {@code field} */ @Nullable @@ -102,6 +104,9 @@ public final String field() { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ @Nullable @@ -110,6 +115,8 @@ public final Integer missing() { } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} */ public final List ranges() { @@ -125,6 +132,9 @@ public final Script script() { } /** + * Set to true to associate a unique string key with each bucket + * and return the ranges as a hash rather than an array. + *

* API name: {@code keyed} */ @Nullable @@ -209,6 +219,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -217,6 +229,9 @@ public final Builder field(@Nullable String value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(@Nullable Integer value) { @@ -225,6 +240,8 @@ public final Builder missing(@Nullable Integer value) { } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} *

* Adds all elements of list to ranges. @@ -235,6 +252,8 @@ public final Builder ranges(List list) { } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} *

* Adds one or more values to ranges. @@ -245,6 +264,8 @@ public final Builder ranges(AggregationRange value, AggregationRange... values) } /** + * An array of ranges used to bucket documents. + *

* API name: {@code ranges} *

* Adds a value to ranges using a builder lambda. @@ -269,6 +290,9 @@ public final Builder script(Function> fn) } /** + * Set to true to associate a unique string key with each bucket + * and return the ranges as a hash rather than an array. + *

* API name: {@code keyed} */ public final Builder keyed(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RareTermsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RareTermsAggregation.java index d86f49849..dd2f7f4ea 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RareTermsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RareTermsAggregation.java @@ -97,6 +97,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * Terms that should be excluded from the aggregation. + *

* API name: {@code exclude} */ @Nullable @@ -105,6 +107,8 @@ public final TermsExclude exclude() { } /** + * The field from which to return rare terms. + *

* API name: {@code field} */ @Nullable @@ -113,6 +117,8 @@ public final String field() { } /** + * Terms that should be included in the aggregation. + *

* API name: {@code include} */ @Nullable @@ -121,6 +127,8 @@ public final TermsInclude include() { } /** + * The maximum number of documents a term should appear in. + *

* API name: {@code max_doc_count} */ @Nullable @@ -129,6 +137,9 @@ public final Long maxDocCount() { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ @Nullable @@ -137,6 +148,9 @@ public final FieldValue missing() { } /** + * The precision of the internal CuckooFilters. Smaller precision leads to + * better approximation, but higher memory usage. + *

* API name: {@code precision} */ @Nullable @@ -224,6 +238,8 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code exclude} */ public final Builder exclude(@Nullable TermsExclude value) { @@ -232,6 +248,8 @@ public final Builder exclude(@Nullable TermsExclude value) { } /** + * Terms that should be excluded from the aggregation. + *

* API name: {@code exclude} */ public final Builder exclude(Function> fn) { @@ -239,6 +257,8 @@ public final Builder exclude(Function * API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -247,6 +267,8 @@ public final Builder field(@Nullable String value) { } /** + * Terms that should be included in the aggregation. + *

* API name: {@code include} */ public final Builder include(@Nullable TermsInclude value) { @@ -255,6 +277,8 @@ public final Builder include(@Nullable TermsInclude value) { } /** + * Terms that should be included in the aggregation. + *

* API name: {@code include} */ public final Builder include(Function> fn) { @@ -262,6 +286,8 @@ public final Builder include(Function * API name: {@code max_doc_count} */ public final Builder maxDocCount(@Nullable Long value) { @@ -270,6 +296,9 @@ public final Builder maxDocCount(@Nullable Long value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(@Nullable FieldValue value) { @@ -278,6 +307,9 @@ public final Builder missing(@Nullable FieldValue value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(Function> fn) { @@ -285,6 +317,9 @@ public final Builder missing(Function * API name: {@code missing} */ public final Builder missing(String value) { @@ -293,6 +328,9 @@ public final Builder missing(String value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(long value) { @@ -301,6 +339,9 @@ public final Builder missing(long value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(double value) { @@ -309,6 +350,9 @@ public final Builder missing(double value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(boolean value) { @@ -317,6 +361,9 @@ public final Builder missing(boolean value) { } /** + * The precision of the internal CuckooFilters. Smaller precision leads to + * better approximation, but higher memory usage. + *

* API name: {@code precision} */ public final Builder precision(@Nullable Double value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateAggregation.java index 656f4f175..7746a7aeb 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateAggregation.java @@ -73,6 +73,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * The interval used to calculate the rate. By default, the interval of the + * date_histogram is used. + *

* API name: {@code unit} */ @Nullable @@ -81,6 +84,8 @@ public final CalendarInterval unit() { } /** + * How the rate is calculated. + *

* API name: {@code mode} */ @Nullable @@ -118,6 +123,9 @@ public static class Builder extends FormatMetricAggregationBase.AbstractBuilder< private RateMode mode; /** + * The interval used to calculate the rate. By default, the interval of the + * date_histogram is used. + *

* API name: {@code unit} */ public final Builder unit(@Nullable CalendarInterval value) { @@ -126,6 +134,8 @@ public final Builder unit(@Nullable CalendarInterval value) { } /** + * How the rate is calculated. + *

* API name: {@code mode} */ public final Builder mode(@Nullable RateMode value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateMode.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateMode.java index 01ee38ba5..56950e404 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateMode.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/RateMode.java @@ -34,8 +34,14 @@ */ @JsonpDeserializable public enum RateMode implements JsonEnum { + /** + * Calculates the sum of all values of the field. + */ Sum("sum"), + /** + * Uses the number of values of the field. + */ ValueCount("value_count"), ; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ReverseNestedAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ReverseNestedAggregation.java index 0cce0f994..06fda3ce2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ReverseNestedAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ReverseNestedAggregation.java @@ -70,6 +70,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * Defines the nested object field that should be joined back to. The default is + * empty, which means that it joins back to the root/main document level. + *

* API name: {@code path} */ @Nullable @@ -101,6 +104,9 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code path} */ public final Builder path(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SamplerAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SamplerAggregation.java index d4f1eada8..790c34827 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SamplerAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SamplerAggregation.java @@ -70,6 +70,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * Limits how many top-scoring documents are collected in the sample processed + * on each shard. + *

* API name: {@code shard_size} */ @Nullable @@ -101,6 +104,9 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ScriptedMetricAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ScriptedMetricAggregation.java index f4f326391..08e4a3296 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ScriptedMetricAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ScriptedMetricAggregation.java @@ -89,6 +89,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * Runs once on each shard after document collection is complete. Allows the + * aggregation to consolidate the state returned from each shard. + *

* API name: {@code combine_script} */ @Nullable @@ -97,6 +100,9 @@ public final Script combineScript() { } /** + * Runs prior to any collection of documents. Allows the aggregation to set up + * any initial state. + *

* API name: {@code init_script} */ @Nullable @@ -105,6 +111,10 @@ public final Script initScript() { } /** + * Run once per document collected. If no combine_script is + * specified, the resulting state needs to be stored in the state + * object. + *

* API name: {@code map_script} */ @Nullable @@ -113,6 +123,10 @@ public final Script mapScript() { } /** + * A global object with script parameters for init, + * map and combine scripts. It is shared between the + * scripts. + *

* API name: {@code params} */ public final Map params() { @@ -120,6 +134,11 @@ public final Map params() { } /** + * Runs once on the coordinating node after all shards have returned their + * results. The script is provided with access to a variable + * states, which is an array of the result of the + * combine_script on each shard. + *

* API name: {@code reduce_script} */ @Nullable @@ -189,6 +208,9 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder * API name: {@code combine_script} */ public final Builder combineScript(@Nullable Script value) { @@ -197,6 +219,9 @@ public final Builder combineScript(@Nullable Script value) { } /** + * Runs once on each shard after document collection is complete. Allows the + * aggregation to consolidate the state returned from each shard. + *

* API name: {@code combine_script} */ public final Builder combineScript(Function> fn) { @@ -204,6 +229,9 @@ public final Builder combineScript(Function * API name: {@code init_script} */ public final Builder initScript(@Nullable Script value) { @@ -212,6 +240,9 @@ public final Builder initScript(@Nullable Script value) { } /** + * Runs prior to any collection of documents. Allows the aggregation to set up + * any initial state. + *

* API name: {@code init_script} */ public final Builder initScript(Function> fn) { @@ -219,6 +250,10 @@ public final Builder initScript(Function> } /** + * Run once per document collected. If no combine_script is + * specified, the resulting state needs to be stored in the state + * object. + *

* API name: {@code map_script} */ public final Builder mapScript(@Nullable Script value) { @@ -227,6 +262,10 @@ public final Builder mapScript(@Nullable Script value) { } /** + * Run once per document collected. If no combine_script is + * specified, the resulting state needs to be stored in the state + * object. + *

* API name: {@code map_script} */ public final Builder mapScript(Function> fn) { @@ -234,6 +273,10 @@ public final Builder mapScript(Function> f } /** + * A global object with script parameters for init, + * map and combine scripts. It is shared between the + * scripts. + *

* API name: {@code params} *

* Adds all entries of map to params. @@ -244,6 +287,10 @@ public final Builder params(Map map) { } /** + * A global object with script parameters for init, + * map and combine scripts. It is shared between the + * scripts. + *

* API name: {@code params} *

* Adds an entry to params. @@ -254,6 +301,11 @@ public final Builder params(String key, JsonData value) { } /** + * Runs once on the coordinating node after all shards have returned their + * results. The script is provided with access to a variable + * states, which is an array of the result of the + * combine_script on each shard. + *

* API name: {@code reduce_script} */ public final Builder reduceScript(@Nullable Script value) { @@ -262,6 +314,11 @@ public final Builder reduceScript(@Nullable Script value) { } /** + * Runs once on the coordinating node after all shards have returned their + * results. The script is provided with access to a variable + * states, which is an array of the result of the + * combine_script on each shard. + *

* API name: {@code reduce_script} */ public final Builder reduceScript(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SerialDifferencingAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SerialDifferencingAggregation.java index 875d2317a..4d8bf1a97 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SerialDifferencingAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SerialDifferencingAggregation.java @@ -70,6 +70,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * The historical bucket to subtract from the current value. Must be a positive, + * non-zero integer. + *

* API name: {@code lag} */ @Nullable @@ -101,6 +104,9 @@ public static class Builder extends PipelineAggregationBase.AbstractBuilder * API name: {@code lag} */ public final Builder lag(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTermsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTermsAggregation.java index 2c7a39d6e..1e38b53dc 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTermsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTermsAggregation.java @@ -130,6 +130,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * A background filter that can be used to focus in on significant terms within + * a narrower context, instead of the entire index. + *

* API name: {@code background_filter} */ @Nullable @@ -138,6 +141,9 @@ public final Query backgroundFilter() { } /** + * Use Chi square, as described in "Information Retrieval", Manning et + * al., Chapter 13.5.2, as the significance score. + *

* API name: {@code chi_square} */ @Nullable @@ -146,6 +152,8 @@ public final ChiSquareHeuristic chiSquare() { } /** + * Terms to exclude. + *

* API name: {@code exclude} */ @Nullable @@ -154,6 +162,9 @@ public final TermsExclude exclude() { } /** + * Mechanism by which the aggregation should be executed: using field values + * directly or using global ordinals. + *

* API name: {@code execution_hint} */ @Nullable @@ -162,6 +173,8 @@ public final TermsAggregationExecutionHint executionHint() { } /** + * The field from which to return significant terms. + *

* API name: {@code field} */ @Nullable @@ -170,6 +183,9 @@ public final String field() { } /** + * Use Google normalized distance as described in "The Google Similarity + * Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + *

* API name: {@code gnd} */ @Nullable @@ -178,6 +194,8 @@ public final GoogleNormalizedDistanceHeuristic gnd() { } /** + * Terms to include. + *

* API name: {@code include} */ @Nullable @@ -186,6 +204,8 @@ public final TermsInclude include() { } /** + * Use JLH score as the significance score. + *

* API name: {@code jlh} */ @Nullable @@ -194,6 +214,9 @@ public final EmptyObject jlh() { } /** + * Only return terms that are found in more than min_doc_count + * hits. + *

* API name: {@code min_doc_count} */ @Nullable @@ -202,6 +225,9 @@ public final Long minDocCount() { } /** + * Use mutual information as described in "Information Retrieval", + * Manning et al., Chapter 13.5.1, as the significance score. + *

* API name: {@code mutual_information} */ @Nullable @@ -210,6 +236,9 @@ public final MutualInformationHeuristic mutualInformation() { } /** + * A simple calculation of the number of documents in the foreground sample with + * a term divided by the number of documents in the background with the term. + *

* API name: {@code percentage} */ @Nullable @@ -218,6 +247,8 @@ public final PercentageScoreHeuristic percentage() { } /** + * Customized score, implemented via a script. + *

* API name: {@code script_heuristic} */ @Nullable @@ -226,6 +257,11 @@ public final ScriptedHeuristic scriptHeuristic() { } /** + * Regulates the certainty a shard has if the term should actually be added to + * the candidate list or not with respect to the min_doc_count. + * Terms will only be considered if their local shard frequency within the set + * is higher than the shard_min_doc_count. + *

* API name: {@code shard_min_doc_count} */ @Nullable @@ -234,6 +270,10 @@ public final Long shardMinDocCount() { } /** + * Can be used to control the volumes of candidate terms produced by each shard. + * By default, shard_size will be automatically estimated based on + * the number of shards and the size parameter. + *

* API name: {@code shard_size} */ @Nullable @@ -242,6 +282,8 @@ public final Integer shardSize() { } /** + * The number of buckets returned out of the overall terms list. + *

* API name: {@code size} */ @Nullable @@ -384,6 +426,9 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code background_filter} */ public final Builder backgroundFilter(@Nullable Query value) { @@ -392,6 +437,9 @@ public final Builder backgroundFilter(@Nullable Query value) { } /** + * A background filter that can be used to focus in on significant terms within + * a narrower context, instead of the entire index. + *

* API name: {@code background_filter} */ public final Builder backgroundFilter(Function> fn) { @@ -399,6 +447,9 @@ public final Builder backgroundFilter(Function * API name: {@code chi_square} */ public final Builder chiSquare(@Nullable ChiSquareHeuristic value) { @@ -407,6 +458,9 @@ public final Builder chiSquare(@Nullable ChiSquareHeuristic value) { } /** + * Use Chi square, as described in "Information Retrieval", Manning et + * al., Chapter 13.5.2, as the significance score. + *

* API name: {@code chi_square} */ public final Builder chiSquare(Function> fn) { @@ -414,6 +468,8 @@ public final Builder chiSquare(Function * API name: {@code exclude} */ public final Builder exclude(@Nullable TermsExclude value) { @@ -422,6 +478,8 @@ public final Builder exclude(@Nullable TermsExclude value) { } /** + * Terms to exclude. + *

* API name: {@code exclude} */ public final Builder exclude(Function> fn) { @@ -429,6 +487,9 @@ public final Builder exclude(Function * API name: {@code execution_hint} */ public final Builder executionHint(@Nullable TermsAggregationExecutionHint value) { @@ -437,6 +498,8 @@ public final Builder executionHint(@Nullable TermsAggregationExecutionHint value } /** + * The field from which to return significant terms. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -445,6 +508,9 @@ public final Builder field(@Nullable String value) { } /** + * Use Google normalized distance as described in "The Google Similarity + * Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + *

* API name: {@code gnd} */ public final Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value) { @@ -453,6 +519,9 @@ public final Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value) { } /** + * Use Google normalized distance as described in "The Google Similarity + * Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + *

* API name: {@code gnd} */ public final Builder gnd( @@ -461,6 +530,8 @@ public final Builder gnd( } /** + * Terms to include. + *

* API name: {@code include} */ public final Builder include(@Nullable TermsInclude value) { @@ -469,6 +540,8 @@ public final Builder include(@Nullable TermsInclude value) { } /** + * Terms to include. + *

* API name: {@code include} */ public final Builder include(Function> fn) { @@ -476,6 +549,8 @@ public final Builder include(Function * API name: {@code jlh} */ public final Builder jlh(@Nullable EmptyObject value) { @@ -484,6 +559,8 @@ public final Builder jlh(@Nullable EmptyObject value) { } /** + * Use JLH score as the significance score. + *

* API name: {@code jlh} */ public final Builder jlh(Function> fn) { @@ -491,6 +568,9 @@ public final Builder jlh(Functionmin_doc_count + * hits. + *

* API name: {@code min_doc_count} */ public final Builder minDocCount(@Nullable Long value) { @@ -499,6 +579,9 @@ public final Builder minDocCount(@Nullable Long value) { } /** + * Use mutual information as described in "Information Retrieval", + * Manning et al., Chapter 13.5.1, as the significance score. + *

* API name: {@code mutual_information} */ public final Builder mutualInformation(@Nullable MutualInformationHeuristic value) { @@ -507,6 +590,9 @@ public final Builder mutualInformation(@Nullable MutualInformationHeuristic valu } /** + * Use mutual information as described in "Information Retrieval", + * Manning et al., Chapter 13.5.1, as the significance score. + *

* API name: {@code mutual_information} */ public final Builder mutualInformation( @@ -515,6 +601,9 @@ public final Builder mutualInformation( } /** + * A simple calculation of the number of documents in the foreground sample with + * a term divided by the number of documents in the background with the term. + *

* API name: {@code percentage} */ public final Builder percentage(@Nullable PercentageScoreHeuristic value) { @@ -523,6 +612,9 @@ public final Builder percentage(@Nullable PercentageScoreHeuristic value) { } /** + * A simple calculation of the number of documents in the foreground sample with + * a term divided by the number of documents in the background with the term. + *

* API name: {@code percentage} */ public final Builder percentage( @@ -531,6 +623,8 @@ public final Builder percentage( } /** + * Customized score, implemented via a script. + *

* API name: {@code script_heuristic} */ public final Builder scriptHeuristic(@Nullable ScriptedHeuristic value) { @@ -539,6 +633,8 @@ public final Builder scriptHeuristic(@Nullable ScriptedHeuristic value) { } /** + * Customized score, implemented via a script. + *

* API name: {@code script_heuristic} */ public final Builder scriptHeuristic(Function> fn) { @@ -546,6 +642,11 @@ public final Builder scriptHeuristic(Functionmin_doc_count. + * Terms will only be considered if their local shard frequency within the set + * is higher than the shard_min_doc_count. + *

* API name: {@code shard_min_doc_count} */ public final Builder shardMinDocCount(@Nullable Long value) { @@ -554,6 +655,10 @@ public final Builder shardMinDocCount(@Nullable Long value) { } /** + * Can be used to control the volumes of candidate terms produced by each shard. + * By default, shard_size will be automatically estimated based on + * the number of shards and the size parameter. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -562,6 +667,8 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * The number of buckets returned out of the overall terms list. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTextAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTextAggregation.java index c61a438ff..cbc22532b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTextAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/SignificantTextAggregation.java @@ -139,6 +139,9 @@ public Aggregation.Kind _aggregationKind() { } /** + * A background filter that can be used to focus in on significant terms within + * a narrower context, instead of the entire index. + *

* API name: {@code background_filter} */ @Nullable @@ -147,6 +150,9 @@ public final Query backgroundFilter() { } /** + * Use Chi square, as described in "Information Retrieval", Manning et + * al., Chapter 13.5.2, as the significance score. + *

* API name: {@code chi_square} */ @Nullable @@ -155,6 +161,8 @@ public final ChiSquareHeuristic chiSquare() { } /** + * Values to exclude. + *

* API name: {@code exclude} */ @Nullable @@ -163,6 +171,9 @@ public final TermsExclude exclude() { } /** + * Determines whether the aggregation will use field values directly or global + * ordinals. + *

* API name: {@code execution_hint} */ @Nullable @@ -171,6 +182,8 @@ public final TermsAggregationExecutionHint executionHint() { } /** + * The field from which to return significant text. + *

* API name: {@code field} */ @Nullable @@ -179,6 +192,8 @@ public final String field() { } /** + * Whether to out duplicate text to deal with noisy data. + *

* API name: {@code filter_duplicate_text} */ @Nullable @@ -187,6 +202,9 @@ public final Boolean filterDuplicateText() { } /** + * Use Google normalized distance as described in "The Google Similarity + * Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + *

* API name: {@code gnd} */ @Nullable @@ -195,6 +213,8 @@ public final GoogleNormalizedDistanceHeuristic gnd() { } /** + * Values to include. + *

* API name: {@code include} */ public final List include() { @@ -202,6 +222,8 @@ public final List include() { } /** + * Use JLH score as the significance score. + *

* API name: {@code jlh} */ @Nullable @@ -210,6 +232,9 @@ public final EmptyObject jlh() { } /** + * Only return values that are found in more than min_doc_count + * hits. + *

* API name: {@code min_doc_count} */ @Nullable @@ -218,6 +243,9 @@ public final Long minDocCount() { } /** + * Use mutual information as described in "Information Retrieval", + * Manning et al., Chapter 13.5.1, as the significance score. + *

* API name: {@code mutual_information} */ @Nullable @@ -226,6 +254,9 @@ public final MutualInformationHeuristic mutualInformation() { } /** + * A simple calculation of the number of documents in the foreground sample with + * a term divided by the number of documents in the background with the term. + *

* API name: {@code percentage} */ @Nullable @@ -234,6 +265,8 @@ public final PercentageScoreHeuristic percentage() { } /** + * Customized score, implemented via a script. + *

* API name: {@code script_heuristic} */ @Nullable @@ -242,6 +275,11 @@ public final ScriptedHeuristic scriptHeuristic() { } /** + * Regulates the certainty a shard has if the values should actually be added to + * the candidate list or not with respect to the min_doc_count. Values will only + * be considered if their local shard frequency within the set is higher than + * the shard_min_doc_count. + *

* API name: {@code shard_min_doc_count} */ @Nullable @@ -250,6 +288,10 @@ public final Long shardMinDocCount() { } /** + * The number of candidate terms produced by each shard. By default, + * shard_size will be automatically estimated based on the number + * of shards and the size parameter. + *

* API name: {@code shard_size} */ @Nullable @@ -258,6 +300,8 @@ public final Integer shardSize() { } /** + * The number of buckets returned out of the overall terms list. + *

* API name: {@code size} */ @Nullable @@ -266,6 +310,9 @@ public final Integer size() { } /** + * Overrides the JSON _source fields from which text will be + * analyzed. + *

* API name: {@code source_fields} */ public final List sourceFields() { @@ -433,6 +480,9 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder sourceFields; /** + * A background filter that can be used to focus in on significant terms within + * a narrower context, instead of the entire index. + *

* API name: {@code background_filter} */ public final Builder backgroundFilter(@Nullable Query value) { @@ -441,6 +491,9 @@ public final Builder backgroundFilter(@Nullable Query value) { } /** + * A background filter that can be used to focus in on significant terms within + * a narrower context, instead of the entire index. + *

* API name: {@code background_filter} */ public final Builder backgroundFilter(Function> fn) { @@ -448,6 +501,9 @@ public final Builder backgroundFilter(Function * API name: {@code chi_square} */ public final Builder chiSquare(@Nullable ChiSquareHeuristic value) { @@ -456,6 +512,9 @@ public final Builder chiSquare(@Nullable ChiSquareHeuristic value) { } /** + * Use Chi square, as described in "Information Retrieval", Manning et + * al., Chapter 13.5.2, as the significance score. + *

* API name: {@code chi_square} */ public final Builder chiSquare(Function> fn) { @@ -463,6 +522,8 @@ public final Builder chiSquare(Function * API name: {@code exclude} */ public final Builder exclude(@Nullable TermsExclude value) { @@ -471,6 +532,8 @@ public final Builder exclude(@Nullable TermsExclude value) { } /** + * Values to exclude. + *

* API name: {@code exclude} */ public final Builder exclude(Function> fn) { @@ -478,6 +541,9 @@ public final Builder exclude(Function * API name: {@code execution_hint} */ public final Builder executionHint(@Nullable TermsAggregationExecutionHint value) { @@ -486,6 +552,8 @@ public final Builder executionHint(@Nullable TermsAggregationExecutionHint value } /** + * The field from which to return significant text. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -494,6 +562,8 @@ public final Builder field(@Nullable String value) { } /** + * Whether to out duplicate text to deal with noisy data. + *

* API name: {@code filter_duplicate_text} */ public final Builder filterDuplicateText(@Nullable Boolean value) { @@ -502,6 +572,9 @@ public final Builder filterDuplicateText(@Nullable Boolean value) { } /** + * Use Google normalized distance as described in "The Google Similarity + * Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + *

* API name: {@code gnd} */ public final Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value) { @@ -510,6 +583,9 @@ public final Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value) { } /** + * Use Google normalized distance as described in "The Google Similarity + * Distance", Cilibrasi and Vitanyi, 2007, as the significance score. + *

* API name: {@code gnd} */ public final Builder gnd( @@ -518,6 +594,8 @@ public final Builder gnd( } /** + * Values to include. + *

* API name: {@code include} *

* Adds all elements of list to include. @@ -528,6 +606,8 @@ public final Builder include(List list) { } /** + * Values to include. + *

* API name: {@code include} *

* Adds one or more values to include. @@ -538,6 +618,8 @@ public final Builder include(String value, String... values) { } /** + * Use JLH score as the significance score. + *

* API name: {@code jlh} */ public final Builder jlh(@Nullable EmptyObject value) { @@ -546,6 +628,8 @@ public final Builder jlh(@Nullable EmptyObject value) { } /** + * Use JLH score as the significance score. + *

* API name: {@code jlh} */ public final Builder jlh(Function> fn) { @@ -553,6 +637,9 @@ public final Builder jlh(Functionmin_doc_count + * hits. + *

* API name: {@code min_doc_count} */ public final Builder minDocCount(@Nullable Long value) { @@ -561,6 +648,9 @@ public final Builder minDocCount(@Nullable Long value) { } /** + * Use mutual information as described in "Information Retrieval", + * Manning et al., Chapter 13.5.1, as the significance score. + *

* API name: {@code mutual_information} */ public final Builder mutualInformation(@Nullable MutualInformationHeuristic value) { @@ -569,6 +659,9 @@ public final Builder mutualInformation(@Nullable MutualInformationHeuristic valu } /** + * Use mutual information as described in "Information Retrieval", + * Manning et al., Chapter 13.5.1, as the significance score. + *

* API name: {@code mutual_information} */ public final Builder mutualInformation( @@ -577,6 +670,9 @@ public final Builder mutualInformation( } /** + * A simple calculation of the number of documents in the foreground sample with + * a term divided by the number of documents in the background with the term. + *

* API name: {@code percentage} */ public final Builder percentage(@Nullable PercentageScoreHeuristic value) { @@ -585,6 +681,9 @@ public final Builder percentage(@Nullable PercentageScoreHeuristic value) { } /** + * A simple calculation of the number of documents in the foreground sample with + * a term divided by the number of documents in the background with the term. + *

* API name: {@code percentage} */ public final Builder percentage( @@ -593,6 +692,8 @@ public final Builder percentage( } /** + * Customized score, implemented via a script. + *

* API name: {@code script_heuristic} */ public final Builder scriptHeuristic(@Nullable ScriptedHeuristic value) { @@ -601,6 +702,8 @@ public final Builder scriptHeuristic(@Nullable ScriptedHeuristic value) { } /** + * Customized score, implemented via a script. + *

* API name: {@code script_heuristic} */ public final Builder scriptHeuristic(Function> fn) { @@ -608,6 +711,11 @@ public final Builder scriptHeuristic(Functionshard_min_doc_count. + *

* API name: {@code shard_min_doc_count} */ public final Builder shardMinDocCount(@Nullable Long value) { @@ -616,6 +724,10 @@ public final Builder shardMinDocCount(@Nullable Long value) { } /** + * The number of candidate terms produced by each shard. By default, + * shard_size will be automatically estimated based on the number + * of shards and the size parameter. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -624,6 +736,8 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * The number of buckets returned out of the overall terms list. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { @@ -632,6 +746,9 @@ public final Builder size(@Nullable Integer value) { } /** + * Overrides the JSON _source fields from which text will be + * analyzed. + *

* API name: {@code source_fields} *

* Adds all elements of list to sourceFields. @@ -642,6 +759,9 @@ public final Builder sourceFields(List list) { } /** + * Overrides the JSON _source fields from which text will be + * analyzed. + *

* API name: {@code source_fields} *

* Adds one or more values to sourceFields. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/StringStatsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/StringStatsAggregation.java index 41dd77dfb..c7543645e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/StringStatsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/StringStatsAggregation.java @@ -70,6 +70,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * Shows the probability distribution for all characters. + *

* API name: {@code show_distribution} */ @Nullable @@ -101,6 +103,8 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder * API name: {@code show_distribution} */ public final Builder showDistribution(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TDigest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TDigest.java index 6de79eef1..8b3fce9b5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TDigest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TDigest.java @@ -63,6 +63,10 @@ public static TDigest of(Function> fn) { } /** + * Limits the maximum number of nodes used by the underlying TDigest algorithm + * to 20 * compression, enabling control of memory usage and + * approximation error. + *

* API name: {@code compression} */ @Nullable @@ -105,6 +109,10 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Integer compression; /** + * Limits the maximum number of nodes used by the underlying TDigest algorithm + * to 20 * compression, enabling control of memory usage and + * approximation error. + *

* API name: {@code compression} */ public final Builder compression(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestAggregation.java index d3698d57c..ebab06841 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestAggregation.java @@ -77,6 +77,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * Test population A. + *

* API name: {@code a} */ @Nullable @@ -85,6 +87,8 @@ public final TestPopulation a() { } /** + * Test population B. + *

* API name: {@code b} */ @Nullable @@ -93,6 +97,8 @@ public final TestPopulation b() { } /** + * The type of test. + *

* API name: {@code type} */ @Nullable @@ -139,6 +145,8 @@ public static class Builder extends AggregationBase.AbstractBuilder private TTestType type; /** + * Test population A. + *

* API name: {@code a} */ public final Builder a(@Nullable TestPopulation value) { @@ -147,6 +155,8 @@ public final Builder a(@Nullable TestPopulation value) { } /** + * Test population A. + *

* API name: {@code a} */ public final Builder a(Function> fn) { @@ -154,6 +164,8 @@ public final Builder a(Function * API name: {@code b} */ public final Builder b(@Nullable TestPopulation value) { @@ -162,6 +174,8 @@ public final Builder b(@Nullable TestPopulation value) { } /** + * Test population B. + *

* API name: {@code b} */ public final Builder b(Function> fn) { @@ -169,6 +183,8 @@ public final Builder b(Function * API name: {@code type} */ public final Builder type(@Nullable TTestType value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestType.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestType.java index f6817d3c5..d05c41288 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestType.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TTestType.java @@ -35,10 +35,19 @@ */ @JsonpDeserializable public enum TTestType implements JsonEnum { + /** + * Performs paired t-test. + */ Paired("paired"), + /** + * Performs two-sample equal variance test. + */ Homoscedastic("homoscedastic"), + /** + * Performs two-sample unequal variance test. + */ Heteroscedastic("heteroscedastic"), ; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregation.java index c40d6b851..4b0c7e075 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregation.java @@ -147,6 +147,9 @@ public PivotGroupBy.Kind _pivotGroupByKind() { } /** + * Determines how child aggregations should be calculated: breadth-first or + * depth-first. + *

* API name: {@code collect_mode} */ @Nullable @@ -155,6 +158,8 @@ public final TermsAggregationCollectMode collectMode() { } /** + * Values to exclude. Accepts regular expressions and partitions. + *

* API name: {@code exclude} */ @Nullable @@ -163,6 +168,9 @@ public final TermsExclude exclude() { } /** + * Determines whether the aggregation will use field values directly or global + * ordinals. + *

* API name: {@code execution_hint} */ @Nullable @@ -171,6 +179,8 @@ public final TermsAggregationExecutionHint executionHint() { } /** + * The field from which to return terms. + *

* API name: {@code field} */ @Nullable @@ -179,6 +189,8 @@ public final String field() { } /** + * Values to include. Accepts regular expressions and partitions. + *

* API name: {@code include} */ @Nullable @@ -187,6 +199,9 @@ public final TermsInclude include() { } /** + * Only return values that are found in more than min_doc_count + * hits. + *

* API name: {@code min_doc_count} */ @Nullable @@ -195,6 +210,9 @@ public final Integer minDocCount() { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ @Nullable @@ -219,6 +237,8 @@ public final Boolean missingBucket() { } /** + * Coerced unmapped fields into the specified type. + *

* API name: {@code value_type} */ @Nullable @@ -227,6 +247,9 @@ public final String valueType() { } /** + * Specifies the sort order of the buckets. Defaults to sorting by descending + * document count. + *

* API name: {@code order} */ public final List> order() { @@ -242,6 +265,10 @@ public final Script script() { } /** + * The number of candidate terms produced by each shard. By default, + * shard_size will be automatically estimated based on the number + * of shards and the size parameter. + *

* API name: {@code shard_size} */ @Nullable @@ -250,6 +277,10 @@ public final Integer shardSize() { } /** + * Set to true to return the + * doc_count_error_upper_bound, which is an upper bound to the + * error on the doc_count returned by each shard. + *

* API name: {@code show_term_doc_count_error} */ @Nullable @@ -258,6 +289,8 @@ public final Boolean showTermDocCountError() { } /** + * The number of buckets returned out of the overall terms list. + *

* API name: {@code size} */ @Nullable @@ -422,6 +455,9 @@ public static class Builder extends BucketAggregationBase.AbstractBuilder * API name: {@code collect_mode} */ public final Builder collectMode(@Nullable TermsAggregationCollectMode value) { @@ -430,6 +466,8 @@ public final Builder collectMode(@Nullable TermsAggregationCollectMode value) { } /** + * Values to exclude. Accepts regular expressions and partitions. + *

* API name: {@code exclude} */ public final Builder exclude(@Nullable TermsExclude value) { @@ -438,6 +476,8 @@ public final Builder exclude(@Nullable TermsExclude value) { } /** + * Values to exclude. Accepts regular expressions and partitions. + *

* API name: {@code exclude} */ public final Builder exclude(Function> fn) { @@ -445,6 +485,9 @@ public final Builder exclude(Function * API name: {@code execution_hint} */ public final Builder executionHint(@Nullable TermsAggregationExecutionHint value) { @@ -453,6 +496,8 @@ public final Builder executionHint(@Nullable TermsAggregationExecutionHint value } /** + * The field from which to return terms. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -461,6 +506,8 @@ public final Builder field(@Nullable String value) { } /** + * Values to include. Accepts regular expressions and partitions. + *

* API name: {@code include} */ public final Builder include(@Nullable TermsInclude value) { @@ -469,6 +516,8 @@ public final Builder include(@Nullable TermsInclude value) { } /** + * Values to include. Accepts regular expressions and partitions. + *

* API name: {@code include} */ public final Builder include(Function> fn) { @@ -476,6 +525,9 @@ public final Builder include(Functionmin_doc_count + * hits. + *

* API name: {@code min_doc_count} */ public final Builder minDocCount(@Nullable Integer value) { @@ -484,6 +536,9 @@ public final Builder minDocCount(@Nullable Integer value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(@Nullable FieldValue value) { @@ -492,6 +547,9 @@ public final Builder missing(@Nullable FieldValue value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(Function> fn) { @@ -499,6 +557,9 @@ public final Builder missing(Function * API name: {@code missing} */ public final Builder missing(String value) { @@ -507,6 +568,9 @@ public final Builder missing(String value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(long value) { @@ -515,6 +579,9 @@ public final Builder missing(long value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(double value) { @@ -523,6 +590,9 @@ public final Builder missing(double value) { } /** + * The value to apply to documents that do not have a value. By default, + * documents without a value are ignored. + *

* API name: {@code missing} */ public final Builder missing(boolean value) { @@ -547,6 +617,8 @@ public final Builder missingBucket(@Nullable Boolean value) { } /** + * Coerced unmapped fields into the specified type. + *

* API name: {@code value_type} */ public final Builder valueType(@Nullable String value) { @@ -555,6 +627,9 @@ public final Builder valueType(@Nullable String value) { } /** + * Specifies the sort order of the buckets. Defaults to sorting by descending + * document count. + *

* API name: {@code order} *

* Adds all elements of list to order. @@ -565,6 +640,9 @@ public final Builder order(List> list) { } /** + * Specifies the sort order of the buckets. Defaults to sorting by descending + * document count. + *

* API name: {@code order} *

* Adds one or more values to order. @@ -590,6 +668,10 @@ public final Builder script(Function> fn) } /** + * The number of candidate terms produced by each shard. By default, + * shard_size will be automatically estimated based on the number + * of shards and the size parameter. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -598,6 +680,10 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * Set to true to return the + * doc_count_error_upper_bound, which is an upper bound to the + * error on the doc_count returned by each shard. + *

* API name: {@code show_term_doc_count_error} */ public final Builder showTermDocCountError(@Nullable Boolean value) { @@ -606,6 +692,8 @@ public final Builder showTermDocCountError(@Nullable Boolean value) { } /** + * The number of buckets returned out of the overall terms list. + *

* API name: {@code size} */ public final Builder size(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregationCollectMode.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregationCollectMode.java index ef44638e8..1e21a465c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregationCollectMode.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsAggregationCollectMode.java @@ -35,8 +35,16 @@ */ @JsonpDeserializable public enum TermsAggregationCollectMode implements JsonEnum { + /** + * Expands all branches of the aggregation tree in one depth-first pass, before + * any pruning occurs. + */ DepthFirst("depth_first"), + /** + * Caches the set of documents that fall into the uppermost buckets for + * subsequent replay. + */ BreadthFirst("breadth_first"), ; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsPartition.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsPartition.java index c35edf0f9..e691a3207 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsPartition.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TermsPartition.java @@ -66,14 +66,18 @@ public static TermsPartition of(Function> } /** - * Required - API name: {@code num_partitions} + * Required - The number of partitions. + *

+ * API name: {@code num_partitions} */ public final long numPartitions() { return this.numPartitions; } /** - * Required - API name: {@code partition} + * Required - The partition number for this request. + *

+ * API name: {@code partition} */ public final long partition() { return this.partition; @@ -115,7 +119,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Long partition; /** - * Required - API name: {@code num_partitions} + * Required - The number of partitions. + *

+ * API name: {@code num_partitions} */ public final Builder numPartitions(long value) { this.numPartitions = value; @@ -123,7 +129,9 @@ public final Builder numPartitions(long value) { } /** - * Required - API name: {@code partition} + * Required - The partition number for this request. + *

+ * API name: {@code partition} */ public final Builder partition(long value) { this.partition = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TestPopulation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TestPopulation.java index 820b4414b..34a1991f3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TestPopulation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TestPopulation.java @@ -74,7 +74,9 @@ public static TestPopulation of(Function> } /** - * Required - API name: {@code field} + * Required - The field to aggregate. + *

+ * API name: {@code field} */ public final String field() { return this.field; @@ -89,6 +91,8 @@ public final Script script() { } /** + * A filter used to define a set of records to run unpaired t-test on. + *

* API name: {@code filter} */ @Nullable @@ -144,7 +148,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Query filter; /** - * Required - API name: {@code field} + * Required - The field to aggregate. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -167,6 +173,8 @@ public final Builder script(Function> fn) } /** + * A filter used to define a set of records to run unpaired t-test on. + *

* API name: {@code filter} */ public final Builder filter(@Nullable Query value) { @@ -175,6 +183,8 @@ public final Builder filter(@Nullable Query value) { } /** + * A filter used to define a set of records to run unpaired t-test on. + *

* API name: {@code filter} */ public final Builder filter(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopHitsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopHitsAggregation.java index a29f60fd4..40a7e457d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopHitsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopHitsAggregation.java @@ -119,6 +119,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * Fields for which to return doc values. + *

* API name: {@code docvalue_fields} */ public final List docvalueFields() { @@ -126,6 +128,9 @@ public final List docvalueFields() { } /** + * If true, returns detailed information about score computation as + * part of a hit. + *

* API name: {@code explain} */ @Nullable @@ -134,6 +139,8 @@ public final Boolean explain() { } /** + * Starting document offset. + *

* API name: {@code from} */ @Nullable @@ -142,6 +149,9 @@ public final Integer from() { } /** + * Specifies the highlighter to use for retrieving highlighted snippets from one + * or more fields in the search results. + *

* API name: {@code highlight} */ @Nullable @@ -150,6 +160,8 @@ public final Highlight highlight() { } /** + * Returns the result of one or more script evaluations for each hit. + *

* API name: {@code script_fields} */ public final Map scriptFields() { @@ -157,6 +169,8 @@ public final Map scriptFields() { } /** + * The maximum number of top matching hits to return per bucket. + *

* API name: {@code size} */ @Nullable @@ -165,6 +179,9 @@ public final Integer size() { } /** + * Sort order of the top matching hits. By default, the hits are sorted by the + * score of the main query. + *

* API name: {@code sort} */ public final List sort() { @@ -172,6 +189,8 @@ public final List sort() { } /** + * Selects the fields of the source that are returned. + *

* API name: {@code _source} */ @Nullable @@ -180,6 +199,9 @@ public final SourceConfig source() { } /** + * Returns values for the specified stored fields (fields that use the + * store mapping option). + *

* API name: {@code stored_fields} */ public final List storedFields() { @@ -187,6 +209,9 @@ public final List storedFields() { } /** + * If true, calculates and returns document scores, even if the + * scores are not used for sorting. + *

* API name: {@code track_scores} */ @Nullable @@ -195,6 +220,8 @@ public final Boolean trackScores() { } /** + * If true, returns document version as part of a hit. + *

* API name: {@code version} */ @Nullable @@ -203,6 +230,9 @@ public final Boolean version() { } /** + * If true, returns sequence number and primary term of the last + * modification of each hit. + *

* API name: {@code seq_no_primary_term} */ @Nullable @@ -343,6 +373,8 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder * API name: {@code docvalue_fields} *

* Adds all elements of list to docvalueFields. @@ -353,6 +385,8 @@ public final Builder docvalueFields(List list) { } /** + * Fields for which to return doc values. + *

* API name: {@code docvalue_fields} *

* Adds one or more values to docvalueFields. @@ -363,6 +397,9 @@ public final Builder docvalueFields(String value, String... values) { } /** + * If true, returns detailed information about score computation as + * part of a hit. + *

* API name: {@code explain} */ public final Builder explain(@Nullable Boolean value) { @@ -371,6 +408,8 @@ public final Builder explain(@Nullable Boolean value) { } /** + * Starting document offset. + *

* API name: {@code from} */ public final Builder from(@Nullable Integer value) { @@ -379,6 +418,9 @@ public final Builder from(@Nullable Integer value) { } /** + * Specifies the highlighter to use for retrieving highlighted snippets from one + * or more fields in the search results. + *

* API name: {@code highlight} */ public final Builder highlight(@Nullable Highlight value) { @@ -387,6 +429,9 @@ public final Builder highlight(@Nullable Highlight value) { } /** + * Specifies the highlighter to use for retrieving highlighted snippets from one + * or more fields in the search results. + *

* API name: {@code highlight} */ public final Builder highlight(Function> fn) { @@ -394,6 +439,8 @@ public final Builder highlight(Function * API name: {@code script_fields} *

* Adds all entries of map to scriptFields. @@ -404,6 +451,8 @@ public final Builder scriptFields(Map map) { } /** + * Returns the result of one or more script evaluations for each hit. + *

* API name: {@code script_fields} *

* Adds an entry to scriptFields. @@ -414,6 +463,8 @@ public final Builder scriptFields(String key, ScriptField value) { } /** + * Returns the result of one or more script evaluations for each hit. + *

* API name: {@code script_fields} *

* Adds an entry to scriptFields using a builder lambda. @@ -423,6 +474,8 @@ public final Builder scriptFields(String key, Function * API name: {@code size} */ public final Builder size(@Nullable Integer value) { @@ -431,6 +484,9 @@ public final Builder size(@Nullable Integer value) { } /** + * Sort order of the top matching hits. By default, the hits are sorted by the + * score of the main query. + *

* API name: {@code sort} *

* Adds all elements of list to sort. @@ -441,6 +497,9 @@ public final Builder sort(List list) { } /** + * Sort order of the top matching hits. By default, the hits are sorted by the + * score of the main query. + *

* API name: {@code sort} *

* Adds one or more values to sort. @@ -451,6 +510,9 @@ public final Builder sort(SortOptions value, SortOptions... values) { } /** + * Sort order of the top matching hits. By default, the hits are sorted by the + * score of the main query. + *

* API name: {@code sort} *

* Adds a value to sort using a builder lambda. @@ -460,6 +522,8 @@ public final Builder sort(Function * API name: {@code _source} */ public final Builder source(@Nullable SourceConfig value) { @@ -468,6 +532,8 @@ public final Builder source(@Nullable SourceConfig value) { } /** + * Selects the fields of the source that are returned. + *

* API name: {@code _source} */ public final Builder source(Function> fn) { @@ -475,6 +541,9 @@ public final Builder source(Functionstore mapping option). + *

* API name: {@code stored_fields} *

* Adds all elements of list to storedFields. @@ -485,6 +554,9 @@ public final Builder storedFields(List list) { } /** + * Returns values for the specified stored fields (fields that use the + * store mapping option). + *

* API name: {@code stored_fields} *

* Adds one or more values to storedFields. @@ -495,6 +567,9 @@ public final Builder storedFields(String value, String... values) { } /** + * If true, calculates and returns document scores, even if the + * scores are not used for sorting. + *

* API name: {@code track_scores} */ public final Builder trackScores(@Nullable Boolean value) { @@ -503,6 +578,8 @@ public final Builder trackScores(@Nullable Boolean value) { } /** + * If true, returns document version as part of a hit. + *

* API name: {@code version} */ public final Builder version(@Nullable Boolean value) { @@ -511,6 +588,9 @@ public final Builder version(@Nullable Boolean value) { } /** + * If true, returns sequence number and primary term of the last + * modification of each hit. + *

* API name: {@code seq_no_primary_term} */ public final Builder seqNoPrimaryTerm(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsAggregation.java index 19f8e00bb..138eb84c5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsAggregation.java @@ -79,6 +79,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The fields of the top document to return. + *

* API name: {@code metrics} */ public final List metrics() { @@ -86,6 +88,8 @@ public final List metrics() { } /** + * The number of top documents from which to return metrics. + *

* API name: {@code size} */ @Nullable @@ -94,6 +98,8 @@ public final Integer size() { } /** + * The sort order of the documents. + *

* API name: {@code sort} */ public final List sort() { @@ -150,6 +156,8 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder sort; /** + * The fields of the top document to return. + *

* API name: {@code metrics} *

* Adds all elements of list to metrics. @@ -160,6 +168,8 @@ public final Builder metrics(List list) { } /** + * The fields of the top document to return. + *

* API name: {@code metrics} *

* Adds one or more values to metrics. @@ -170,6 +180,8 @@ public final Builder metrics(TopMetricsValue value, TopMetricsValue... values) { } /** + * The fields of the top document to return. + *

* API name: {@code metrics} *

* Adds a value to metrics using a builder lambda. @@ -179,6 +191,8 @@ public final Builder metrics(Function * API name: {@code size} */ public final Builder size(@Nullable Integer value) { @@ -187,6 +201,8 @@ public final Builder size(@Nullable Integer value) { } /** + * The sort order of the documents. + *

* API name: {@code sort} *

* Adds all elements of list to sort. @@ -197,6 +213,8 @@ public final Builder sort(List list) { } /** + * The sort order of the documents. + *

* API name: {@code sort} *

* Adds one or more values to sort. @@ -207,6 +225,8 @@ public final Builder sort(SortOptions value, SortOptions... values) { } /** + * The sort order of the documents. + *

* API name: {@code sort} *

* Adds a value to sort using a builder lambda. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsValue.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsValue.java index eb4d2b4c8..a63e963cd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsValue.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/TopMetricsValue.java @@ -64,7 +64,9 @@ public static TopMetricsValue of(Function + * API name: {@code field} */ public final String field() { return this.field; @@ -101,7 +103,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private String field; /** - * Required - API name: {@code field} + * Required - A field to return as a metric. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/VariableWidthHistogramAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/VariableWidthHistogramAggregation.java index 05474a8db..8035e3a25 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/VariableWidthHistogramAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/VariableWidthHistogramAggregation.java @@ -86,6 +86,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * The name of the field. + *

* API name: {@code field} */ @Nullable @@ -94,6 +96,8 @@ public final String field() { } /** + * The target number of buckets. + *

* API name: {@code buckets} */ @Nullable @@ -102,6 +106,9 @@ public final Integer buckets() { } /** + * The number of buckets that the coordinating node will request from each + * shard. Defaults to buckets * 50. + *

* API name: {@code shard_size} */ @Nullable @@ -110,6 +117,10 @@ public final Integer shardSize() { } /** + * Specifies the number of individual documents that will be stored in memory on + * a shard before the initial bucketing algorithm is run. Defaults to + * min(10 * shard_size, 50000). + *

* API name: {@code initial_buffer} */ @Nullable @@ -178,6 +189,8 @@ public static class Builder extends WithJsonObjectBuilderBase private Integer initialBuffer; /** + * The name of the field. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -186,6 +199,8 @@ public final Builder field(@Nullable String value) { } /** + * The target number of buckets. + *

* API name: {@code buckets} */ public final Builder buckets(@Nullable Integer value) { @@ -194,6 +209,9 @@ public final Builder buckets(@Nullable Integer value) { } /** + * The number of buckets that the coordinating node will request from each + * shard. Defaults to buckets * 50. + *

* API name: {@code shard_size} */ public final Builder shardSize(@Nullable Integer value) { @@ -202,6 +220,10 @@ public final Builder shardSize(@Nullable Integer value) { } /** + * Specifies the number of individual documents that will be stored in memory on + * a shard before the initial bucketing algorithm is run. Defaults to + * min(10 * shard_size, 50000). + *

* API name: {@code initial_buffer} */ public final Builder initialBuffer(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageAggregation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageAggregation.java index 59c6891af..a3f788b80 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageAggregation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageAggregation.java @@ -82,6 +82,8 @@ public Aggregation.Kind _aggregationKind() { } /** + * A numeric response formatter. + *

* API name: {@code format} */ @Nullable @@ -90,6 +92,8 @@ public final String format() { } /** + * Configuration for the field that provides the values. + *

* API name: {@code value} */ @Nullable @@ -106,6 +110,8 @@ public final ValueType valueType() { } /** + * Configuration for the field or script that provides the weights. + *

* API name: {@code weight} */ @Nullable @@ -160,6 +166,8 @@ public static class Builder extends AggregationBase.AbstractBuilder private WeightedAverageValue weight; /** + * A numeric response formatter. + *

* API name: {@code format} */ public final Builder format(@Nullable String value) { @@ -168,6 +176,8 @@ public final Builder format(@Nullable String value) { } /** + * Configuration for the field that provides the values. + *

* API name: {@code value} */ public final Builder value(@Nullable WeightedAverageValue value) { @@ -176,6 +186,8 @@ public final Builder value(@Nullable WeightedAverageValue value) { } /** + * Configuration for the field that provides the values. + *

* API name: {@code value} */ public final Builder value(Function> fn) { @@ -191,6 +203,8 @@ public final Builder valueType(@Nullable ValueType value) { } /** + * Configuration for the field or script that provides the weights. + *

* API name: {@code weight} */ public final Builder weight(@Nullable WeightedAverageValue value) { @@ -199,6 +213,8 @@ public final Builder weight(@Nullable WeightedAverageValue value) { } /** + * Configuration for the field or script that provides the weights. + *

* API name: {@code weight} */ public final Builder weight(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageValue.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageValue.java index 77efc9b23..8e42d00a1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageValue.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/WeightedAverageValue.java @@ -74,6 +74,8 @@ public static WeightedAverageValue of(Function * API name: {@code field} */ @Nullable @@ -82,6 +84,8 @@ public final String field() { } /** + * A value or weight to use if the field is missing. + *

* API name: {@code missing} */ @Nullable @@ -150,6 +154,8 @@ public static class Builder extends WithJsonObjectBuilderBase private Script script; /** + * The field from which to extract the values or weights. + *

* API name: {@code field} */ public final Builder field(@Nullable String value) { @@ -158,6 +164,8 @@ public final Builder field(@Nullable String value) { } /** + * A value or weight to use if the field is missing. + *

* API name: {@code missing} */ public final Builder missing(@Nullable Double value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/PatternTokenizer.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/PatternTokenizer.java index 03e7f20ef..c378d434c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/PatternTokenizer.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/analysis/PatternTokenizer.java @@ -28,7 +28,6 @@ import co.elastic.clients.json.JsonpMapper; import co.elastic.clients.json.ObjectBuilderDeserializer; import co.elastic.clients.json.ObjectDeserializer; -import co.elastic.clients.util.ApiTypeHelper; import co.elastic.clients.util.ObjectBuilder; import jakarta.json.stream.JsonGenerator; import java.lang.Integer; @@ -47,10 +46,13 @@ */ @JsonpDeserializable public class PatternTokenizer extends TokenizerBase implements TokenizerDefinitionVariant { + @Nullable private final String flags; - private final int group; + @Nullable + private final Integer group; + @Nullable private final String pattern; // --------------------------------------------------------------------------------------------- @@ -58,9 +60,9 @@ public class PatternTokenizer extends TokenizerBase implements TokenizerDefiniti private PatternTokenizer(Builder builder) { super(builder); - this.flags = ApiTypeHelper.requireNonNull(builder.flags, this, "flags"); - this.group = ApiTypeHelper.requireNonNull(builder.group, this, "group"); - this.pattern = ApiTypeHelper.requireNonNull(builder.pattern, this, "pattern"); + this.flags = builder.flags; + this.group = builder.group; + this.pattern = builder.pattern; } @@ -77,22 +79,25 @@ public TokenizerDefinition.Kind _tokenizerDefinitionKind() { } /** - * Required - API name: {@code flags} + * API name: {@code flags} */ + @Nullable public final String flags() { return this.flags; } /** - * Required - API name: {@code group} + * API name: {@code group} */ - public final int group() { + @Nullable + public final Integer group() { return this.group; } /** - * Required - API name: {@code pattern} + * API name: {@code pattern} */ + @Nullable public final String pattern() { return this.pattern; } @@ -101,14 +106,21 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.write("type", "pattern"); super.serializeInternal(generator, mapper); - generator.writeKey("flags"); - generator.write(this.flags); + if (this.flags != null) { + generator.writeKey("flags"); + generator.write(this.flags); - generator.writeKey("group"); - generator.write(this.group); + } + if (this.group != null) { + generator.writeKey("group"); + generator.write(this.group); + + } + if (this.pattern != null) { + generator.writeKey("pattern"); + generator.write(this.pattern); - generator.writeKey("pattern"); - generator.write(this.pattern); + } } @@ -121,32 +133,35 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { public static class Builder extends TokenizerBase.AbstractBuilder implements ObjectBuilder { + @Nullable private String flags; + @Nullable private Integer group; + @Nullable private String pattern; /** - * Required - API name: {@code flags} + * API name: {@code flags} */ - public final Builder flags(String value) { + public final Builder flags(@Nullable String value) { this.flags = value; return this; } /** - * Required - API name: {@code group} + * API name: {@code group} */ - public final Builder group(int value) { + public final Builder group(@Nullable Integer value) { this.group = value; return this; } /** - * Required - API name: {@code pattern} + * API name: {@code pattern} */ - public final Builder pattern(String value) { + public final Builder pattern(@Nullable String value) { this.pattern = value; return this; } diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlag.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlag.java index 9422125c4..2daae2a24 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlag.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlag.java @@ -46,14 +46,14 @@ public enum SimpleQueryStringFlag implements JsonEnum { And("AND"), /** - * Enables the \| OR operator. + * Enables the - NOT operator. */ - Or("OR"), + Not("NOT"), /** - * Enables the - NOT operator. + * Enables the \| OR operator. */ - Not("NOT"), + Or("OR"), /** * Enables the * prefix operator. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlags.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlags.java deleted file mode 100644 index a43ff2a9a..000000000 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlags.java +++ /dev/null @@ -1,192 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -//---------------------------------------------------- -// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. -//---------------------------------------------------- - -package co.elastic.clients.elasticsearch._types.query_dsl; - -import co.elastic.clients.json.JsonpDeserializable; -import co.elastic.clients.json.JsonpDeserializer; -import co.elastic.clients.json.JsonpMapper; -import co.elastic.clients.json.JsonpSerializable; -import co.elastic.clients.json.JsonpUtils; -import co.elastic.clients.json.ObjectDeserializer; -import co.elastic.clients.json.UnionDeserializer; -import co.elastic.clients.util.ApiTypeHelper; -import co.elastic.clients.util.ObjectBuilder; -import co.elastic.clients.util.ObjectBuilderBase; -import co.elastic.clients.util.TaggedUnion; -import co.elastic.clients.util.TaggedUnionUtils; -import jakarta.json.stream.JsonGenerator; -import java.lang.Object; -import java.lang.String; -import java.util.Objects; -import java.util.function.Function; -import javax.annotation.Nullable; - -// typedef: _types.query_dsl.SimpleQueryStringFlags - -/** - * Query flags can be either a single flag or a combination of flags, e.g. - * OR|AND|PREFIX - * - * @see Documentation - * on elastic.co - * @see API - * specification - */ -@JsonpDeserializable -public class SimpleQueryStringFlags implements TaggedUnion, JsonpSerializable { - - public enum Kind { - Single, Multiple - - } - - private final Kind _kind; - private final Object _value; - - @Override - public final Kind _kind() { - return _kind; - } - - @Override - public final Object _get() { - return _value; - } - - private SimpleQueryStringFlags(Kind kind, Object value) { - this._kind = kind; - this._value = value; - } - - public String _toJsonString() { - switch (_kind) { - case Single : - return this.single().jsonValue(); - case Multiple : - return this.multiple(); - - default : - throw new IllegalStateException("Unknown kind " + _kind); - } - } - - private SimpleQueryStringFlags(Builder builder) { - - this._kind = ApiTypeHelper.requireNonNull(builder._kind, builder, ""); - this._value = ApiTypeHelper.requireNonNull(builder._value, builder, ""); - - } - - public static SimpleQueryStringFlags of(Function> fn) { - return fn.apply(new Builder()).build(); - } - - /** - * Is this variant instance of kind {@code single}? - */ - public boolean isSingle() { - return _kind == Kind.Single; - } - - /** - * Get the {@code single} variant value. - * - * @throws IllegalStateException - * if the current variant is not of the {@code single} kind. - */ - public SimpleQueryStringFlag single() { - return TaggedUnionUtils.get(this, Kind.Single); - } - - /** - * Is this variant instance of kind {@code multiple}? - */ - public boolean isMultiple() { - return _kind == Kind.Multiple; - } - - /** - * Get the {@code multiple} variant value. - * - * @throws IllegalStateException - * if the current variant is not of the {@code multiple} kind. - */ - public String multiple() { - return TaggedUnionUtils.get(this, Kind.Multiple); - } - - @Override - public void serialize(JsonGenerator generator, JsonpMapper mapper) { - if (_value instanceof JsonpSerializable) { - ((JsonpSerializable) _value).serialize(generator, mapper); - } else { - switch (_kind) { - case Multiple : - generator.write(((String) this._value)); - - break; - } - } - - } - - @Override - public String toString() { - return JsonpUtils.toString(this); - } - - public static class Builder extends ObjectBuilderBase implements ObjectBuilder { - private Kind _kind; - private Object _value; - - public ObjectBuilder single(SimpleQueryStringFlag v) { - this._kind = Kind.Single; - this._value = v; - return this; - } - - public ObjectBuilder multiple(String v) { - this._kind = Kind.Multiple; - this._value = v; - return this; - } - - public SimpleQueryStringFlags build() { - _checkSingleUse(); - return new SimpleQueryStringFlags(this); - } - - } - - private static JsonpDeserializer buildSimpleQueryStringFlagsDeserializer() { - return new UnionDeserializer.Builder(SimpleQueryStringFlags::new, true) - .addMember(Kind.Single, SimpleQueryStringFlag._DESERIALIZER) - .addMember(Kind.Multiple, JsonpDeserializer.stringDeserializer()).build(); - } - - public static final JsonpDeserializer _DESERIALIZER = JsonpDeserializer - .lazy(SimpleQueryStringFlags::buildSimpleQueryStringFlagsDeserializer); -} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlagsBuilders.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlagsBuilders.java deleted file mode 100644 index 00ae85425..000000000 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringFlagsBuilders.java +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -//---------------------------------------------------- -// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. -//---------------------------------------------------- - -package co.elastic.clients.elasticsearch._types.query_dsl; - -import co.elastic.clients.util.ObjectBuilder; -import java.util.function.Function; - -/** - * Builders for {@link SimpleQueryStringFlags} variants. - *

- * Variants single, multiple are not available here as - * they don't have a dedicated class. Use {@link SimpleQueryStringFlags}'s - * builder for these. - * - */ -public class SimpleQueryStringFlagsBuilders { - private SimpleQueryStringFlagsBuilders() { - } - -} diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringQuery.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringQuery.java index 4696f624b..be1e24cae 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringQuery.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/_types/query_dsl/SimpleQueryStringQuery.java @@ -23,6 +23,7 @@ package co.elastic.clients.elasticsearch._types.query_dsl; +import co.elastic.clients.json.JsonEnums; import co.elastic.clients.json.JsonpDeserializable; import co.elastic.clients.json.JsonpDeserializer; import co.elastic.clients.json.JsonpMapper; @@ -63,8 +64,7 @@ public class SimpleQueryStringQuery extends QueryBase implements QueryVariant { private final List fields; - @Nullable - private final SimpleQueryStringFlags flags; + private final List flags; @Nullable private final Integer fuzzyMaxExpansions; @@ -96,7 +96,7 @@ private SimpleQueryStringQuery(Builder builder) { this.autoGenerateSynonymsPhraseQuery = builder.autoGenerateSynonymsPhraseQuery; this.defaultOperator = builder.defaultOperator; this.fields = ApiTypeHelper.unmodifiable(builder.fields); - this.flags = builder.flags; + this.flags = ApiTypeHelper.unmodifiable(builder.flags); this.fuzzyMaxExpansions = builder.fuzzyMaxExpansions; this.fuzzyPrefixLength = builder.fuzzyPrefixLength; this.fuzzyTranspositions = builder.fuzzyTranspositions; @@ -180,8 +180,7 @@ public final List fields() { *

* API name: {@code flags} */ - @Nullable - public final SimpleQueryStringFlags flags() { + public final List flags() { return this.flags; } @@ -289,10 +288,9 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.writeEnd(); } - if (this.flags != null) { + if (ApiTypeHelper.isDefined(this.flags)) { generator.writeKey("flags"); - this.flags.serialize(generator, mapper); - + JsonEnums.serializePipeSeparated(this.flags, generator); } if (this.fuzzyMaxExpansions != null) { generator.writeKey("fuzzy_max_expansions"); @@ -355,7 +353,7 @@ public static class Builder extends QueryBase.AbstractBuilder private List fields; @Nullable - private SimpleQueryStringFlags flags; + private List flags; @Nullable private Integer fuzzyMaxExpansions; @@ -456,9 +454,11 @@ public final Builder fields(String value, String... values) { * List of enabled operators for the simple query string syntax. *

* API name: {@code flags} + *

+ * Adds all elements of list to flags. */ - public final Builder flags(@Nullable SimpleQueryStringFlags value) { - this.flags = value; + public final Builder flags(List list) { + this.flags = _listAddAll(this.flags, list); return this; } @@ -466,9 +466,12 @@ public final Builder flags(@Nullable SimpleQueryStringFlags value) { * List of enabled operators for the simple query string syntax. *

* API name: {@code flags} + *

+ * Adds one or more values to flags. */ - public final Builder flags(Function> fn) { - return this.flags(fn.apply(new SimpleQueryStringFlags.Builder()).build()); + public final Builder flags(SimpleQueryStringFlag value, SimpleQueryStringFlag... values) { + this.flags = _listAdd(this.flags, value, values); + return this; } /** @@ -579,7 +582,8 @@ protected static void setupSimpleQueryStringQueryDeserializer( "auto_generate_synonyms_phrase_query"); op.add(Builder::defaultOperator, Operator._DESERIALIZER, "default_operator"); op.add(Builder::fields, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), "fields"); - op.add(Builder::flags, SimpleQueryStringFlags._DESERIALIZER, "flags"); + op.add(Builder::flags, JsonpDeserializer.pipeSeparatedDeserializer(SimpleQueryStringFlag._DESERIALIZER), + "flags"); op.add(Builder::fuzzyMaxExpansions, JsonpDeserializer.integerDeserializer(), "fuzzy_max_expansions"); op.add(Builder::fuzzyPrefixLength, JsonpDeserializer.integerDeserializer(), "fuzzy_prefix_length"); op.add(Builder::fuzzyTranspositions, JsonpDeserializer.booleanDeserializer(), "fuzzy_transpositions"); diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/HealthReportResponse.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/HealthReportResponse.java index 5a8c53521..4c9923457 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/core/HealthReportResponse.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/core/HealthReportResponse.java @@ -23,6 +23,7 @@ package co.elastic.clients.elasticsearch.core; +import co.elastic.clients.elasticsearch.core.health_report.IndicatorHealthStatus; import co.elastic.clients.elasticsearch.core.health_report.Indicators; import co.elastic.clients.json.JsonpDeserializable; import co.elastic.clients.json.JsonpDeserializer; @@ -53,12 +54,16 @@ public class HealthReportResponse implements JsonpSerializable { private final Indicators indicators; + @Nullable + private final IndicatorHealthStatus status; + // --------------------------------------------------------------------------------------------- private HealthReportResponse(Builder builder) { this.clusterName = ApiTypeHelper.requireNonNull(builder.clusterName, this, "clusterName"); this.indicators = ApiTypeHelper.requireNonNull(builder.indicators, this, "indicators"); + this.status = builder.status; } @@ -80,6 +85,14 @@ public final Indicators indicators() { return this.indicators; } + /** + * API name: {@code status} + */ + @Nullable + public final IndicatorHealthStatus status() { + return this.status; + } + /** * Serialize this object to JSON. */ @@ -97,6 +110,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { generator.writeKey("indicators"); this.indicators.serialize(generator, mapper); + if (this.status != null) { + generator.writeKey("status"); + this.status.serialize(generator, mapper); + } + } @Override @@ -117,6 +135,9 @@ public static class Builder extends WithJsonObjectBuilderBase private Indicators indicators; + @Nullable + private IndicatorHealthStatus status; + /** * Required - API name: {@code cluster_name} */ @@ -140,6 +161,14 @@ public final Builder indicators(Function 1) { hash = hash.substring(1); } - window.location = "https://github.com/elastic/elasticsearch-specification/tree/94a333068d5de803bad4893bbc971574c1260d2d/specification/" + (paths[hash] || ""); + window.location = "https://github.com/elastic/elasticsearch-specification/tree/de09c3f9203eb71b39d67863616ccd9bd997acbf/specification/" + (paths[hash] || ""); - Please see the Elasticsearch API specification. + Please see the Elasticsearch API specification. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AppendProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AppendProcessor.java index a4fd364c4..52b275198 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AppendProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AppendProcessor.java @@ -79,20 +79,27 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to be appended to. Supports template snippets. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** - * Required - API name: {@code value} + * Required - The value to be appended. Supports template snippets. + *

+ * API name: {@code value} */ public final List value() { return this.value; } /** + * If false, the processor does not append values already present + * in the field. + *

* API name: {@code allow_duplicates} */ @Nullable @@ -141,7 +148,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private Boolean allowDuplicates; /** - * Required - API name: {@code field} + * Required - The field to be appended to. Supports template snippets. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -149,7 +158,9 @@ public final Builder field(String value) { } /** - * Required - API name: {@code value} + * Required - The value to be appended. Supports template snippets. + *

+ * API name: {@code value} *

* Adds all elements of list to value. */ @@ -159,7 +170,9 @@ public final Builder value(List list) { } /** - * Required - API name: {@code value} + * Required - The value to be appended. Supports template snippets. + *

+ * API name: {@code value} *

* Adds one or more values to value. */ @@ -169,6 +182,9 @@ public final Builder value(JsonData value, JsonData... values) { } /** + * If false, the processor does not append values already present + * in the field. + *

* API name: {@code allow_duplicates} */ public final Builder allowDuplicates(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AttachmentProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AttachmentProcessor.java index 39a763b96..552952b9e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AttachmentProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/AttachmentProcessor.java @@ -96,13 +96,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to get the base64 encoded field from. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor quietly exits + * without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -111,6 +116,9 @@ public final Boolean ignoreMissing() { } /** + * The number of chars being used for extraction to prevent huge fields. Use + * -1 for no limit. + *

* API name: {@code indexed_chars} */ @Nullable @@ -119,6 +127,9 @@ public final Long indexedChars() { } /** + * Field name from which you can overwrite the number of chars being used for + * extraction. + *

* API name: {@code indexed_chars_field} */ @Nullable @@ -127,6 +138,11 @@ public final String indexedCharsField() { } /** + * Array of properties to select to be stored. Can be content, + * title, name, author, + * keywords, date, content_type, + * content_length, language. + *

* API name: {@code properties} */ public final List properties() { @@ -134,6 +150,8 @@ public final List properties() { } /** + * The field that will hold the attachment information. + *

* API name: {@code target_field} */ @Nullable @@ -142,6 +160,10 @@ public final String targetField() { } /** + * Field containing the name of the resource to decode. If specified, the + * processor passes this resource name to the underlying Tika library to enable + * Resource Name Based Detection. + *

* API name: {@code resource_name} */ @Nullable @@ -223,7 +245,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String resourceName; /** - * Required - API name: {@code field} + * Required - The field to get the base64 encoded field from. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -231,6 +255,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor quietly exits + * without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -239,6 +266,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The number of chars being used for extraction to prevent huge fields. Use + * -1 for no limit. + *

* API name: {@code indexed_chars} */ public final Builder indexedChars(@Nullable Long value) { @@ -247,6 +277,9 @@ public final Builder indexedChars(@Nullable Long value) { } /** + * Field name from which you can overwrite the number of chars being used for + * extraction. + *

* API name: {@code indexed_chars_field} */ public final Builder indexedCharsField(@Nullable String value) { @@ -255,6 +288,11 @@ public final Builder indexedCharsField(@Nullable String value) { } /** + * Array of properties to select to be stored. Can be content, + * title, name, author, + * keywords, date, content_type, + * content_length, language. + *

* API name: {@code properties} *

* Adds all elements of list to properties. @@ -265,6 +303,11 @@ public final Builder properties(List list) { } /** + * Array of properties to select to be stored. Can be content, + * title, name, author, + * keywords, date, content_type, + * content_length, language. + *

* API name: {@code properties} *

* Adds one or more values to properties. @@ -275,6 +318,8 @@ public final Builder properties(String value, String... values) { } /** + * The field that will hold the attachment information. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { @@ -283,6 +328,10 @@ public final Builder targetField(@Nullable String value) { } /** + * Field containing the name of the resource to decode. If specified, the + * processor passes this resource name to the underlying Tika library to enable + * Resource Name Based Detection. + *

* API name: {@code resource_name} */ public final Builder resourceName(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/BytesProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/BytesProcessor.java index 15e2a28f4..8f0ee4961 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/BytesProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/BytesProcessor.java @@ -78,13 +78,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to convert. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -93,6 +99,9 @@ public final Boolean ignoreMissing() { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -137,7 +146,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field to convert. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -145,6 +156,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -153,6 +168,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CircleProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CircleProcessor.java index 64b9986a5..43c7547e2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CircleProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CircleProcessor.java @@ -85,20 +85,30 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code error_distance} + * Required - The difference between the resulting inscribed distance from + * center to side and the circle’s radius (measured in meters for + * geo_shape, unit-less for shape). + *

+ * API name: {@code error_distance} */ public final double errorDistance() { return this.errorDistance; } /** - * Required - API name: {@code field} + * Required - The field to interpret as a circle. Either a string in WKT format + * or a map for GeoJSON. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -107,13 +117,19 @@ public final Boolean ignoreMissing() { } /** - * Required - API name: {@code shape_type} + * Required - Which field mapping type is to be used when processing the circle: + * geo_shape or shape. + *

+ * API name: {@code shape_type} */ public final ShapeType shapeType() { return this.shapeType; } /** + * The field to assign the polygon shape to By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -167,7 +183,11 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code error_distance} + * Required - The difference between the resulting inscribed distance from + * center to side and the circle’s radius (measured in meters for + * geo_shape, unit-less for shape). + *

+ * API name: {@code error_distance} */ public final Builder errorDistance(double value) { this.errorDistance = value; @@ -175,7 +195,10 @@ public final Builder errorDistance(double value) { } /** - * Required - API name: {@code field} + * Required - The field to interpret as a circle. Either a string in WKT format + * or a map for GeoJSON. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -183,6 +206,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -191,7 +217,10 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** - * Required - API name: {@code shape_type} + * Required - Which field mapping type is to be used when processing the circle: + * geo_shape or shape. + *

+ * API name: {@code shape_type} */ public final Builder shapeType(ShapeType value) { this.shapeType = value; @@ -199,6 +228,9 @@ public final Builder shapeType(ShapeType value) { } /** + * The field to assign the polygon shape to By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertProcessor.java index aee60555b..44f799d9b 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ConvertProcessor.java @@ -81,13 +81,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field whose value is to be converted. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -96,6 +102,9 @@ public final Boolean ignoreMissing() { } /** + * The field to assign the converted value to. By default, the + * field is updated in-place. + *

* API name: {@code target_field} */ @Nullable @@ -104,7 +113,9 @@ public final String targetField() { } /** - * Required - API name: {@code type} + * Required - The type to convert the existing value to. + *

+ * API name: {@code type} */ public final ConvertType type() { return this.type; @@ -151,7 +162,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private ConvertType type; /** - * Required - API name: {@code field} + * Required - The field whose value is to be converted. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -159,6 +172,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -167,6 +184,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The field to assign the converted value to. By default, the + * field is updated in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { @@ -175,7 +195,9 @@ public final Builder targetField(@Nullable String value) { } /** - * Required - API name: {@code type} + * Required - The type to convert the existing value to. + *

+ * API name: {@code type} */ public final Builder type(ConvertType value) { this.type = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CsvProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CsvProcessor.java index 829b6c7bf..3c63277c0 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CsvProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/CsvProcessor.java @@ -95,6 +95,10 @@ public Processor.Kind _processorKind() { } /** + * Value used to fill empty fields. Empty fields are skipped if this is not + * provided. An empty field is one with no value (2 consecutive separators) or + * empty quotes (""). + *

* API name: {@code empty_value} */ @Nullable @@ -103,13 +107,18 @@ public final JsonData emptyValue() { } /** - * Required - API name: {@code field} + * Required - The field to extract data from. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -118,6 +127,8 @@ public final Boolean ignoreMissing() { } /** + * Quote used in CSV, has to be single character string. + *

* API name: {@code quote} */ @Nullable @@ -126,6 +137,8 @@ public final String quote() { } /** + * Separator used in CSV, has to be single character string. + *

* API name: {@code separator} */ @Nullable @@ -134,13 +147,17 @@ public final String separator() { } /** - * Required - API name: {@code target_fields} + * Required - The array of fields to assign extracted values to. + *

+ * API name: {@code target_fields} */ public final List targetFields() { return this.targetFields; } /** + * Trim whitespaces in unquoted fields. + *

* API name: {@code trim} */ @Nullable @@ -219,6 +236,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private Boolean trim; /** + * Value used to fill empty fields. Empty fields are skipped if this is not + * provided. An empty field is one with no value (2 consecutive separators) or + * empty quotes (""). + *

* API name: {@code empty_value} */ public final Builder emptyValue(@Nullable JsonData value) { @@ -227,7 +248,9 @@ public final Builder emptyValue(@Nullable JsonData value) { } /** - * Required - API name: {@code field} + * Required - The field to extract data from. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -235,6 +258,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -243,6 +269,8 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * Quote used in CSV, has to be single character string. + *

* API name: {@code quote} */ public final Builder quote(@Nullable String value) { @@ -251,6 +279,8 @@ public final Builder quote(@Nullable String value) { } /** + * Separator used in CSV, has to be single character string. + *

* API name: {@code separator} */ public final Builder separator(@Nullable String value) { @@ -259,7 +289,9 @@ public final Builder separator(@Nullable String value) { } /** - * Required - API name: {@code target_fields} + * Required - The array of fields to assign extracted values to. + *

+ * API name: {@code target_fields} *

* Adds all elements of list to targetFields. */ @@ -269,7 +301,9 @@ public final Builder targetFields(List list) { } /** - * Required - API name: {@code target_fields} + * Required - The array of fields to assign extracted values to. + *

+ * API name: {@code target_fields} *

* Adds one or more values to targetFields. */ @@ -279,6 +313,8 @@ public final Builder targetFields(String value, String... values) { } /** + * Trim whitespaces in unquoted fields. + *

* API name: {@code trim} */ public final Builder trim(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateIndexNameProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateIndexNameProcessor.java index 824300c49..282eedca9 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateIndexNameProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateIndexNameProcessor.java @@ -93,7 +93,11 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code date_formats} + * Required - An array of the expected date formats for parsing dates / + * timestamps in the document being preprocessed. Can be a java time pattern or + * one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + *

+ * API name: {@code date_formats} */ public final List dateFormats() { return this.dateFormats; @@ -113,13 +117,18 @@ public final String dateRounding() { } /** - * Required - API name: {@code field} + * Required - The field to get the date or timestamp from. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * The format to be used when printing the parsed date into the index name. A + * valid java time pattern is expected here. Supports template snippets. + *

* API name: {@code index_name_format} */ @Nullable @@ -128,6 +137,9 @@ public final String indexNameFormat() { } /** + * A prefix of the index name to be prepended before the printed date. Supports + * template snippets. + *

* API name: {@code index_name_prefix} */ @Nullable @@ -136,6 +148,9 @@ public final String indexNamePrefix() { } /** + * The locale to use when parsing the date from the document being preprocessed, + * relevant when parsing month names or week days. + *

* API name: {@code locale} */ @Nullable @@ -144,6 +159,9 @@ public final String locale() { } /** + * The timezone to use when parsing the date and when date math index supports + * resolves expressions into concrete index names. + *

* API name: {@code timezone} */ @Nullable @@ -221,7 +239,11 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String timezone; /** - * Required - API name: {@code date_formats} + * Required - An array of the expected date formats for parsing dates / + * timestamps in the document being preprocessed. Can be a java time pattern or + * one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + *

+ * API name: {@code date_formats} *

* Adds all elements of list to dateFormats. */ @@ -231,7 +253,11 @@ public final Builder dateFormats(List list) { } /** - * Required - API name: {@code date_formats} + * Required - An array of the expected date formats for parsing dates / + * timestamps in the document being preprocessed. Can be a java time pattern or + * one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + *

+ * API name: {@code date_formats} *

* Adds one or more values to dateFormats. */ @@ -255,7 +281,9 @@ public final Builder dateRounding(String value) { } /** - * Required - API name: {@code field} + * Required - The field to get the date or timestamp from. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -263,6 +291,9 @@ public final Builder field(String value) { } /** + * The format to be used when printing the parsed date into the index name. A + * valid java time pattern is expected here. Supports template snippets. + *

* API name: {@code index_name_format} */ public final Builder indexNameFormat(@Nullable String value) { @@ -271,6 +302,9 @@ public final Builder indexNameFormat(@Nullable String value) { } /** + * A prefix of the index name to be prepended before the printed date. Supports + * template snippets. + *

* API name: {@code index_name_prefix} */ public final Builder indexNamePrefix(@Nullable String value) { @@ -279,6 +313,9 @@ public final Builder indexNamePrefix(@Nullable String value) { } /** + * The locale to use when parsing the date from the document being preprocessed, + * relevant when parsing month names or week days. + *

* API name: {@code locale} */ public final Builder locale(@Nullable String value) { @@ -287,6 +324,9 @@ public final Builder locale(@Nullable String value) { } /** + * The timezone to use when parsing the date and when date math index supports + * resolves expressions into concrete index names. + *

* API name: {@code timezone} */ public final Builder timezone(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java index c00de4e62..0f416e61f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DateProcessor.java @@ -85,20 +85,28 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to get the date from. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** - * Required - API name: {@code formats} + * Required - An array of the expected date formats. Can be a java time pattern + * or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + *

+ * API name: {@code formats} */ public final List formats() { return this.formats; } /** + * The locale to use when parsing the date, relevant when parsing month names or + * week days. Supports template snippets. + *

* API name: {@code locale} */ @Nullable @@ -107,6 +115,8 @@ public final String locale() { } /** + * The field that will hold the parsed date. + *

* API name: {@code target_field} */ @Nullable @@ -115,6 +125,8 @@ public final String targetField() { } /** + * The timezone to use when parsing the date. Supports template snippets. + *

* API name: {@code timezone} */ @Nullable @@ -177,7 +189,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String timezone; /** - * Required - API name: {@code field} + * Required - The field to get the date from. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -185,7 +199,10 @@ public final Builder field(String value) { } /** - * Required - API name: {@code formats} + * Required - An array of the expected date formats. Can be a java time pattern + * or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + *

+ * API name: {@code formats} *

* Adds all elements of list to formats. */ @@ -195,7 +212,10 @@ public final Builder formats(List list) { } /** - * Required - API name: {@code formats} + * Required - An array of the expected date formats. Can be a java time pattern + * or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + *

+ * API name: {@code formats} *

* Adds one or more values to formats. */ @@ -205,6 +225,9 @@ public final Builder formats(String value, String... values) { } /** + * The locale to use when parsing the date, relevant when parsing month names or + * week days. Supports template snippets. + *

* API name: {@code locale} */ public final Builder locale(@Nullable String value) { @@ -213,6 +236,8 @@ public final Builder locale(@Nullable String value) { } /** + * The field that will hold the parsed date. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { @@ -221,6 +246,8 @@ public final Builder targetField(@Nullable String value) { } /** + * The timezone to use when parsing the date. Supports template snippets. + *

* API name: {@code timezone} */ public final Builder timezone(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DeletePipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DeletePipelineRequest.java index ce3c5baa2..4f8be9e46 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DeletePipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DeletePipelineRequest.java @@ -45,7 +45,7 @@ // typedef: ingest.delete_pipeline.Request /** - * Deletes a pipeline. + * Deletes one or more existing ingest pipeline. * * @see API * specification @@ -75,7 +75,9 @@ public static DeletePipelineRequest of(Function*. *

* API name: {@code id} */ @@ -84,7 +86,8 @@ public final String id() { } /** - * Explicit operation timeout for connection to master node + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ @@ -94,7 +97,8 @@ public final Time masterTimeout() { } /** - * Explicit operation timeout + * Period to wait for a response. If no response is received before the timeout + * expires, the request fails and returns an error. *

* API name: {@code timeout} */ @@ -121,7 +125,9 @@ public static class Builder extends RequestBase.AbstractBuilder private Time timeout; /** - * Required - Pipeline ID + * Required - Pipeline ID or wildcard expression of pipeline IDs used to limit + * the request. To delete all ingest pipelines in a cluster, use a value of + * *. *

* API name: {@code id} */ @@ -131,7 +137,8 @@ public final Builder id(String value) { } /** - * Explicit operation timeout for connection to master node + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ @@ -141,7 +148,8 @@ public final Builder masterTimeout(@Nullable Time value) { } /** - * Explicit operation timeout for connection to master node + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ @@ -150,7 +158,8 @@ public final Builder masterTimeout(Function> f } /** - * Explicit operation timeout + * Period to wait for a response. If no response is received before the timeout + * expires, the request fails and returns an error. *

* API name: {@code timeout} */ @@ -160,7 +169,8 @@ public final Builder timeout(@Nullable Time value) { } /** - * Explicit operation timeout + * Period to wait for a response. If no response is received before the timeout + * expires, the request fails and returns an error. *

* API name: {@code timeout} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DissectProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DissectProcessor.java index ef9e01bbd..4fdfb44a3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DissectProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DissectProcessor.java @@ -81,6 +81,8 @@ public Processor.Kind _processorKind() { } /** + * The character(s) that separate the appended fields. + *

* API name: {@code append_separator} */ @Nullable @@ -89,13 +91,19 @@ public final String appendSeparator() { } /** - * Required - API name: {@code field} + * Required - The field to dissect. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -104,7 +112,9 @@ public final Boolean ignoreMissing() { } /** - * Required - API name: {@code pattern} + * Required - The pattern to apply to the field. + *

+ * API name: {@code pattern} */ public final String pattern() { return this.pattern; @@ -151,6 +161,8 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String pattern; /** + * The character(s) that separate the appended fields. + *

* API name: {@code append_separator} */ public final Builder appendSeparator(@Nullable String value) { @@ -159,7 +171,9 @@ public final Builder appendSeparator(@Nullable String value) { } /** - * Required - API name: {@code field} + * Required - The field to dissect. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -167,6 +181,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -175,7 +193,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** - * Required - API name: {@code pattern} + * Required - The pattern to apply to the field. + *

+ * API name: {@code pattern} */ public final Builder pattern(String value) { this.pattern = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DotExpanderProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DotExpanderProcessor.java index 433ad38de..be448b9bb 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DotExpanderProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/DotExpanderProcessor.java @@ -74,13 +74,20 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to expand into an object field. If set to + * *, all top-level fields will be expanded. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * The field that contains the field to expand. Only required if the field to + * expand is part another object field, because the field option + * can only understand leaf fields. + *

* API name: {@code path} */ @Nullable @@ -117,7 +124,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String path; /** - * Required - API name: {@code field} + * Required - The field to expand into an object field. If set to + * *, all top-level fields will be expanded. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -125,6 +135,10 @@ public final Builder field(String value) { } /** + * The field that contains the field to expand. Only required if the field to + * expand is part another object field, because the field option + * can only understand leaf fields. + *

* API name: {@code path} */ public final Builder path(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java index dbda378cd..c19cfc176 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestAsyncClient.java @@ -93,7 +93,7 @@ public final CompletableFuture deletePipeline( * Returns statistical information about geoip databases * * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/geoip-processor.html">Documentation * on elastic.co */ public CompletableFuture geoIpStats() { @@ -153,7 +153,7 @@ public CompletableFuture getPipeline() { * Returns a list of the built-in patterns. * * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/grok-processor.html">Documentation * on elastic.co */ public CompletableFuture processorGrok() { @@ -167,7 +167,7 @@ public CompletableFuture processorGrok() { * Creates or updates a pipeline. * * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ingest.html">Documentation * on elastic.co */ @@ -185,7 +185,7 @@ public CompletableFuture putPipeline(PutPipelineRequest req * a function that initializes a builder to create the * {@link PutPipelineRequest} * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ingest.html">Documentation * on elastic.co */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java index 4cb628c1d..de1d39b0d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ElasticsearchIngestClient.java @@ -95,7 +95,7 @@ public final DeletePipelineResponse deletePipeline( * Returns statistical information about geoip databases * * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/geoip-processor.html">Documentation * on elastic.co */ public GeoIpStatsResponse geoIpStats() throws IOException, ElasticsearchException { @@ -156,7 +156,7 @@ public GetPipelineResponse getPipeline() throws IOException, ElasticsearchExcept * Returns a list of the built-in patterns. * * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/grok-processor.html">Documentation * on elastic.co */ public ProcessorGrokResponse processorGrok() throws IOException, ElasticsearchException { @@ -170,7 +170,7 @@ public ProcessorGrokResponse processorGrok() throws IOException, ElasticsearchEx * Creates or updates a pipeline. * * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ingest.html">Documentation * on elastic.co */ @@ -188,7 +188,7 @@ public PutPipelineResponse putPipeline(PutPipelineRequest request) throws IOExce * a function that initializes a builder to create the * {@link PutPipelineRequest} * @see Documentation + * "https://www.elastic.co/guide/en/elasticsearch/reference/8.10/ingest.html">Documentation * on elastic.co */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/EnrichProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/EnrichProcessor.java index 2f5b9d41c..638d0cf03 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/EnrichProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/EnrichProcessor.java @@ -94,13 +94,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field in the input document that matches the policies + * match_field used to retrieve the enrichment data. Supports template snippets. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -109,6 +115,12 @@ public final Boolean ignoreMissing() { } /** + * The maximum number of matched documents to include under the configured + * target field. The target_field will be turned into a json array + * if max_matches is higher than 1, otherwise + * target_field will become a json object. In order to avoid + * documents getting too large, the maximum allowed value is 128. + *

* API name: {@code max_matches} */ @Nullable @@ -117,6 +129,9 @@ public final Integer maxMatches() { } /** + * If processor will update fields with pre-existing non-null-valued field. When + * set to false, such fields will not be touched. + *

* API name: {@code override} */ @Nullable @@ -125,13 +140,19 @@ public final Boolean override() { } /** - * Required - API name: {@code policy_name} + * Required - The name of the enrich policy to use. + *

+ * API name: {@code policy_name} */ public final String policyName() { return this.policyName; } /** + * A spatial relation operator used to match the geoshape of incoming documents + * to documents in the enrich index. This option is only used for + * geo_match enrich policy types. + *

* API name: {@code shape_relation} */ @Nullable @@ -140,7 +161,12 @@ public final GeoShapeRelation shapeRelation() { } /** - * Required - API name: {@code target_field} + * Required - Field added to incoming documents to contain enrich data. This + * field contains both the match_field and + * enrich_fields specified in the enrich policy. Supports template + * snippets. + *

+ * API name: {@code target_field} */ public final String targetField() { return this.targetField; @@ -207,7 +233,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field in the input document that matches the policies + * match_field used to retrieve the enrichment data. Supports template snippets. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -215,6 +244,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -223,6 +255,12 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The maximum number of matched documents to include under the configured + * target field. The target_field will be turned into a json array + * if max_matches is higher than 1, otherwise + * target_field will become a json object. In order to avoid + * documents getting too large, the maximum allowed value is 128. + *

* API name: {@code max_matches} */ public final Builder maxMatches(@Nullable Integer value) { @@ -231,6 +269,9 @@ public final Builder maxMatches(@Nullable Integer value) { } /** + * If processor will update fields with pre-existing non-null-valued field. When + * set to false, such fields will not be touched. + *

* API name: {@code override} */ public final Builder override(@Nullable Boolean value) { @@ -239,7 +280,9 @@ public final Builder override(@Nullable Boolean value) { } /** - * Required - API name: {@code policy_name} + * Required - The name of the enrich policy to use. + *

+ * API name: {@code policy_name} */ public final Builder policyName(String value) { this.policyName = value; @@ -247,6 +290,10 @@ public final Builder policyName(String value) { } /** + * A spatial relation operator used to match the geoshape of incoming documents + * to documents in the enrich index. This option is only used for + * geo_match enrich policy types. + *

* API name: {@code shape_relation} */ public final Builder shapeRelation(@Nullable GeoShapeRelation value) { @@ -255,7 +302,12 @@ public final Builder shapeRelation(@Nullable GeoShapeRelation value) { } /** - * Required - API name: {@code target_field} + * Required - Field added to incoming documents to contain enrich data. This + * field contains both the match_field and + * enrich_fields specified in the enrich policy. Supports template + * snippets. + *

+ * API name: {@code target_field} */ public final Builder targetField(String value) { this.targetField = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FailProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FailProcessor.java index 8c3e1f218..24a193bfd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FailProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/FailProcessor.java @@ -69,7 +69,10 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code message} + * Required - The error message thrown by the processor. Supports template + * snippets. + *

+ * API name: {@code message} */ public final String message() { return this.message; @@ -93,7 +96,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String message; /** - * Required - API name: {@code message} + * Required - The error message thrown by the processor. Supports template + * snippets. + *

+ * API name: {@code message} */ public final Builder message(String value) { this.message = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ForeachProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ForeachProcessor.java index 8fada737d..38e47a8a1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ForeachProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ForeachProcessor.java @@ -77,13 +77,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - Field containing array or object values. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true, the processor silently exits without changing the + * document if the field is null or missing. + *

* API name: {@code ignore_missing} */ @Nullable @@ -92,7 +97,9 @@ public final Boolean ignoreMissing() { } /** - * Required - API name: {@code processor} + * Required - Ingest processor to run on each element. + *

+ * API name: {@code processor} */ public final Processor processor() { return this.processor; @@ -131,7 +138,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private Processor processor; /** - * Required - API name: {@code field} + * Required - Field containing array or object values. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -139,6 +148,9 @@ public final Builder field(String value) { } /** + * If true, the processor silently exits without changing the + * document if the field is null or missing. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -147,7 +159,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** - * Required - API name: {@code processor} + * Required - Ingest processor to run on each element. + *

+ * API name: {@code processor} */ public final Builder processor(Processor value) { this.processor = value; @@ -155,7 +169,9 @@ public final Builder processor(Processor value) { } /** - * Required - API name: {@code processor} + * Required - Ingest processor to run on each element. + *

+ * API name: {@code processor} */ public final Builder processor(Function> fn) { return this.processor(fn.apply(new Processor.Builder()).build()); diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpProcessor.java index 67914a74f..a9ac669fa 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpProcessor.java @@ -90,6 +90,10 @@ public Processor.Kind _processorKind() { } /** + * The database filename referring to a database the module ships with + * (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom + * database in the ingest-geoip config directory. + *

* API name: {@code database_file} */ @Nullable @@ -98,13 +102,18 @@ public final String databaseFile() { } /** - * Required - API name: {@code field} + * Required - The field to get the ip address from for the geographical lookup. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true, only the first found geoip data will be returned, even + * if the field contains an array. + *

* API name: {@code first_only} */ @Nullable @@ -113,6 +122,9 @@ public final Boolean firstOnly() { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -121,6 +133,9 @@ public final Boolean ignoreMissing() { } /** + * Controls what properties are added to the target_field based on + * the geoip lookup. + *

* API name: {@code properties} */ public final List properties() { @@ -128,6 +143,9 @@ public final List properties() { } /** + * The field that will hold the geographical information looked up from the + * MaxMind database. + *

* API name: {@code target_field} */ @Nullable @@ -201,6 +219,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** + * The database filename referring to a database the module ships with + * (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom + * database in the ingest-geoip config directory. + *

* API name: {@code database_file} */ public final Builder databaseFile(@Nullable String value) { @@ -209,7 +231,9 @@ public final Builder databaseFile(@Nullable String value) { } /** - * Required - API name: {@code field} + * Required - The field to get the ip address from for the geographical lookup. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -217,6 +241,9 @@ public final Builder field(String value) { } /** + * If true, only the first found geoip data will be returned, even + * if the field contains an array. + *

* API name: {@code first_only} */ public final Builder firstOnly(@Nullable Boolean value) { @@ -225,6 +252,9 @@ public final Builder firstOnly(@Nullable Boolean value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -233,6 +263,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * Controls what properties are added to the target_field based on + * the geoip lookup. + *

* API name: {@code properties} *

* Adds all elements of list to properties. @@ -243,6 +276,9 @@ public final Builder properties(List list) { } /** + * Controls what properties are added to the target_field based on + * the geoip lookup. + *

* API name: {@code properties} *

* Adds one or more values to properties. @@ -253,6 +289,9 @@ public final Builder properties(String value, String... values) { } /** + * The field that will hold the geographical information looked up from the + * MaxMind database. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpStatsRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpStatsRequest.java index c6868e514..a41ed4847 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpStatsRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GeoIpStatsRequest.java @@ -39,7 +39,7 @@ // typedef: ingest.geo_ip_stats.Request /** - * Returns statistical information about geoip databases + * Gets download statistics for GeoIP2 databases used with the geoip processor. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GetPipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GetPipelineRequest.java index a2c89ad61..77d366805 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GetPipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GetPipelineRequest.java @@ -45,7 +45,8 @@ // typedef: ingest.get_pipeline.Request /** - * Returns a pipeline. + * Returns information about one or more ingest pipelines. This API returns a + * local reference of the pipeline. * * @see API * specification @@ -76,7 +77,9 @@ public static GetPipelineRequest of(Function*) + * expressions are supported. To get all ingest pipelines, omit this parameter + * or use *. *

* API name: {@code id} */ @@ -86,7 +89,8 @@ public final String id() { } /** - * Explicit operation timeout for connection to master node + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ @@ -124,7 +128,9 @@ public static class Builder extends RequestBase.AbstractBuilder private Boolean summary; /** - * Comma separated list of pipeline ids. Wildcards supported + * Comma-separated list of pipeline IDs to retrieve. Wildcard (*) + * expressions are supported. To get all ingest pipelines, omit this parameter + * or use *. *

* API name: {@code id} */ @@ -134,7 +140,8 @@ public final Builder id(@Nullable String value) { } /** - * Explicit operation timeout for connection to master node + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ @@ -144,7 +151,8 @@ public final Builder masterTimeout(@Nullable Time value) { } /** - * Explicit operation timeout for connection to master node + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java index 0c1064560..7a8219279 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GrokProcessor.java @@ -86,13 +86,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to use for grok expression parsing. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -101,6 +107,10 @@ public final Boolean ignoreMissing() { } /** + * A map of pattern-name and pattern tuples defining custom patterns to be used + * by the current processor. Patterns matching existing names will override the + * pre-existing definition. + *

* API name: {@code pattern_definitions} */ public final Map patternDefinitions() { @@ -108,13 +118,20 @@ public final Map patternDefinitions() { } /** - * Required - API name: {@code patterns} + * Required - An ordered list of grok expression to match and extract named + * captures with. Returns on the first expression in the list that matches. + *

+ * API name: {@code patterns} */ public final List patterns() { return this.patterns; } /** + * When true, _ingest._grok_match_index will be + * inserted into your matched document’s metadata with the index into the + * pattern found in patterns that matched. + *

* API name: {@code trace_match} */ @Nullable @@ -183,7 +200,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private Boolean traceMatch; /** - * Required - API name: {@code field} + * Required - The field to use for grok expression parsing. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -191,6 +210,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -199,6 +222,10 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * A map of pattern-name and pattern tuples defining custom patterns to be used + * by the current processor. Patterns matching existing names will override the + * pre-existing definition. + *

* API name: {@code pattern_definitions} *

* Adds all entries of map to patternDefinitions. @@ -209,6 +236,10 @@ public final Builder patternDefinitions(Map map) { } /** + * A map of pattern-name and pattern tuples defining custom patterns to be used + * by the current processor. Patterns matching existing names will override the + * pre-existing definition. + *

* API name: {@code pattern_definitions} *

* Adds an entry to patternDefinitions. @@ -219,7 +250,10 @@ public final Builder patternDefinitions(String key, String value) { } /** - * Required - API name: {@code patterns} + * Required - An ordered list of grok expression to match and extract named + * captures with. Returns on the first expression in the list that matches. + *

+ * API name: {@code patterns} *

* Adds all elements of list to patterns. */ @@ -229,7 +263,10 @@ public final Builder patterns(List list) { } /** - * Required - API name: {@code patterns} + * Required - An ordered list of grok expression to match and extract named + * captures with. Returns on the first expression in the list that matches. + *

+ * API name: {@code patterns} *

* Adds one or more values to patterns. */ @@ -239,6 +276,10 @@ public final Builder patterns(String value, String... values) { } /** + * When true, _ingest._grok_match_index will be + * inserted into your matched document’s metadata with the index into the + * pattern found in patterns that matched. + *

* API name: {@code trace_match} */ public final Builder traceMatch(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GsubProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GsubProcessor.java index 1ee917448..0b80436b5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GsubProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/GsubProcessor.java @@ -84,13 +84,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to apply the replacement to. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -99,20 +105,27 @@ public final Boolean ignoreMissing() { } /** - * Required - API name: {@code pattern} + * Required - The pattern to be replaced. + *

+ * API name: {@code pattern} */ public final String pattern() { return this.pattern; } /** - * Required - API name: {@code replacement} + * Required - The string to replace the matching patterns with. + *

+ * API name: {@code replacement} */ public final String replacement() { return this.replacement; } /** + * The field to assign the converted value to By default, the field + * is updated in-place. + *

* API name: {@code target_field} */ @Nullable @@ -165,7 +178,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String targetField; /** - * Required - API name: {@code field} + * Required - The field to apply the replacement to. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -173,6 +188,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -181,7 +200,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** - * Required - API name: {@code pattern} + * Required - The pattern to be replaced. + *

+ * API name: {@code pattern} */ public final Builder pattern(String value) { this.pattern = value; @@ -189,7 +210,9 @@ public final Builder pattern(String value) { } /** - * Required - API name: {@code replacement} + * Required - The string to replace the matching patterns with. + *

+ * API name: {@code replacement} */ public final Builder replacement(String value) { this.replacement = value; @@ -197,6 +220,9 @@ public final Builder replacement(String value) { } /** + * The field to assign the converted value to By default, the field + * is updated in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigClassification.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigClassification.java index 02347a2a9..6f5383048 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigClassification.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigClassification.java @@ -89,6 +89,8 @@ public InferenceConfig.Kind _inferenceConfigKind() { } /** + * Specifies the number of top class predictions to return. + *

* API name: {@code num_top_classes} */ @Nullable @@ -97,6 +99,8 @@ public final Integer numTopClasses() { } /** + * Specifies the maximum number of feature importance values per document. + *

* API name: {@code num_top_feature_importance_values} */ @Nullable @@ -105,6 +109,9 @@ public final Integer numTopFeatureImportanceValues() { } /** + * The field that is added to incoming documents to contain the inference + * prediction. + *

* API name: {@code results_field} */ @Nullable @@ -113,6 +120,8 @@ public final String resultsField() { } /** + * Specifies the field to which the top classes are written. + *

* API name: {@code top_classes_results_field} */ @Nullable @@ -121,6 +130,9 @@ public final String topClassesResultsField() { } /** + * Specifies the type of the predicted field to write. Valid values are: + * string, number, boolean. + *

* API name: {@code prediction_field_type} */ @Nullable @@ -197,6 +209,8 @@ public static class Builder extends WithJsonObjectBuilderBase private String predictionFieldType; /** + * Specifies the number of top class predictions to return. + *

* API name: {@code num_top_classes} */ public final Builder numTopClasses(@Nullable Integer value) { @@ -205,6 +219,8 @@ public final Builder numTopClasses(@Nullable Integer value) { } /** + * Specifies the maximum number of feature importance values per document. + *

* API name: {@code num_top_feature_importance_values} */ public final Builder numTopFeatureImportanceValues(@Nullable Integer value) { @@ -213,6 +229,9 @@ public final Builder numTopFeatureImportanceValues(@Nullable Integer value) { } /** + * The field that is added to incoming documents to contain the inference + * prediction. + *

* API name: {@code results_field} */ public final Builder resultsField(@Nullable String value) { @@ -221,6 +240,8 @@ public final Builder resultsField(@Nullable String value) { } /** + * Specifies the field to which the top classes are written. + *

* API name: {@code top_classes_results_field} */ public final Builder topClassesResultsField(@Nullable String value) { @@ -229,6 +250,9 @@ public final Builder topClassesResultsField(@Nullable String value) { } /** + * Specifies the type of the predicted field to write. Valid values are: + * string, number, boolean. + *

* API name: {@code prediction_field_type} */ public final Builder predictionFieldType(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigRegression.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigRegression.java index cc616d2e8..5e3e7dcb3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigRegression.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceConfigRegression.java @@ -77,6 +77,9 @@ public InferenceConfig.Kind _inferenceConfigKind() { } /** + * The field that is added to incoming documents to contain the inference + * prediction. + *

* API name: {@code results_field} */ @Nullable @@ -85,6 +88,8 @@ public final String resultsField() { } /** + * Specifies the maximum number of feature importance values per document. + *

* API name: {@code num_top_feature_importance_values} */ @Nullable @@ -137,6 +142,9 @@ public static class Builder extends WithJsonObjectBuilderBase private Integer numTopFeatureImportanceValues; /** + * The field that is added to incoming documents to contain the inference + * prediction. + *

* API name: {@code results_field} */ public final Builder resultsField(@Nullable String value) { @@ -145,6 +153,8 @@ public final Builder resultsField(@Nullable String value) { } /** + * Specifies the maximum number of feature importance values per document. + *

* API name: {@code num_top_feature_importance_values} */ public final Builder numTopFeatureImportanceValues(@Nullable Integer value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceProcessor.java index 410b49220..eb202638a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/InferenceProcessor.java @@ -83,13 +83,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code model_id} + * Required - The ID or alias for the trained model, or the ID of the + * deployment. + *

+ * API name: {@code model_id} */ public final String modelId() { return this.modelId; } /** + * Field added to incoming documents to contain results objects. + *

* API name: {@code target_field} */ @Nullable @@ -98,6 +103,10 @@ public final String targetField() { } /** + * Maps the document field names to the known field names of the model. This + * mapping takes precedence over any default mappings provided in the model + * configuration. + *

* API name: {@code field_map} */ public final Map fieldMap() { @@ -105,6 +114,8 @@ public final Map fieldMap() { } /** + * Contains the inference type and its options. + *

* API name: {@code inference_config} */ @Nullable @@ -163,7 +174,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder private InferenceConfig inferenceConfig; /** - * Required - API name: {@code model_id} + * Required - The ID or alias for the trained model, or the ID of the + * deployment. + *

+ * API name: {@code model_id} */ public final Builder modelId(String value) { this.modelId = value; @@ -171,6 +185,8 @@ public final Builder modelId(String value) { } /** + * Field added to incoming documents to contain results objects. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { @@ -179,6 +195,10 @@ public final Builder targetField(@Nullable String value) { } /** + * Maps the document field names to the known field names of the model. This + * mapping takes precedence over any default mappings provided in the model + * configuration. + *

* API name: {@code field_map} *

* Adds all entries of map to fieldMap. @@ -189,6 +209,10 @@ public final Builder fieldMap(Map map) { } /** + * Maps the document field names to the known field names of the model. This + * mapping takes precedence over any default mappings provided in the model + * configuration. + *

* API name: {@code field_map} *

* Adds an entry to fieldMap. @@ -199,6 +223,8 @@ public final Builder fieldMap(String key, JsonData value) { } /** + * Contains the inference type and its options. + *

* API name: {@code inference_config} */ public final Builder inferenceConfig(@Nullable InferenceConfig value) { @@ -207,6 +233,8 @@ public final Builder inferenceConfig(@Nullable InferenceConfig value) { } /** + * Contains the inference type and its options. + *

* API name: {@code inference_config} */ public final Builder inferenceConfig(Function> fn) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JoinProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JoinProcessor.java index 96b5222d2..c596490b5 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JoinProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JoinProcessor.java @@ -76,20 +76,27 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - Field containing array values to join. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** - * Required - API name: {@code separator} + * Required - The separator character. + *

+ * API name: {@code separator} */ public final String separator() { return this.separator; } /** + * The field to assign the joined value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -129,7 +136,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String targetField; /** - * Required - API name: {@code field} + * Required - Field containing array values to join. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -137,7 +146,9 @@ public final Builder field(String value) { } /** - * Required - API name: {@code separator} + * Required - The separator character. + *

+ * API name: {@code separator} */ public final Builder separator(String value) { this.separator = value; @@ -145,6 +156,9 @@ public final Builder separator(String value) { } /** + * The field to assign the joined value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JsonProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JsonProcessor.java index fded242b7..c5bc16d6c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JsonProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/JsonProcessor.java @@ -86,6 +86,10 @@ public Processor.Kind _processorKind() { } /** + * Flag that forces the parsed JSON to be added at the top level of the + * document. target_field must not be set when this option is + * chosen. + *

* API name: {@code add_to_root} */ @Nullable @@ -94,6 +98,11 @@ public final Boolean addToRoot() { } /** + * When set to replace, root fields that conflict with fields from + * the parsed JSON will be overridden. When set to merge, + * conflicting fields will be merged. Only applicable + * if add_to_root is set to true. + *

* API name: {@code add_to_root_conflict_strategy} */ @Nullable @@ -102,6 +111,10 @@ public final JsonProcessorConflictStrategy addToRootConflictStrategy() { } /** + * When set to true, the JSON parser will not fail if the JSON + * contains duplicate keys. Instead, the last encountered value for any + * duplicate key wins. + *

* API name: {@code allow_duplicate_keys} */ @Nullable @@ -110,13 +123,18 @@ public final Boolean allowDuplicateKeys() { } /** - * Required - API name: {@code field} + * Required - The field to be parsed. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * The field that the converted structured object will be written into. Any + * existing content in this field will be overwritten. + *

* API name: {@code target_field} */ @Nullable @@ -174,6 +192,10 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String targetField; /** + * Flag that forces the parsed JSON to be added at the top level of the + * document. target_field must not be set when this option is + * chosen. + *

* API name: {@code add_to_root} */ public final Builder addToRoot(@Nullable Boolean value) { @@ -182,6 +204,11 @@ public final Builder addToRoot(@Nullable Boolean value) { } /** + * When set to replace, root fields that conflict with fields from + * the parsed JSON will be overridden. When set to merge, + * conflicting fields will be merged. Only applicable + * if add_to_root is set to true. + *

* API name: {@code add_to_root_conflict_strategy} */ public final Builder addToRootConflictStrategy(@Nullable JsonProcessorConflictStrategy value) { @@ -190,6 +217,10 @@ public final Builder addToRootConflictStrategy(@Nullable JsonProcessorConflictSt } /** + * When set to true, the JSON parser will not fail if the JSON + * contains duplicate keys. Instead, the last encountered value for any + * duplicate key wins. + *

* API name: {@code allow_duplicate_keys} */ public final Builder allowDuplicateKeys(@Nullable Boolean value) { @@ -198,7 +229,9 @@ public final Builder allowDuplicateKeys(@Nullable Boolean value) { } /** - * Required - API name: {@code field} + * Required - The field to be parsed. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -206,6 +239,9 @@ public final Builder field(String value) { } /** + * The field that the converted structured object will be written into. Any + * existing content in this field will be overwritten. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/KeyValueProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/KeyValueProcessor.java index a98b0135d..055673400 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/KeyValueProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/KeyValueProcessor.java @@ -107,6 +107,8 @@ public Processor.Kind _processorKind() { } /** + * List of keys to exclude from document. + *

* API name: {@code exclude_keys} */ public final List excludeKeys() { @@ -114,20 +116,28 @@ public final List excludeKeys() { } /** - * Required - API name: {@code field} + * Required - The field to be parsed. Supports template snippets. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** - * Required - API name: {@code field_split} + * Required - Regex pattern to use for splitting key-value pairs. + *

+ * API name: {@code field_split} */ public final String fieldSplit() { return this.fieldSplit; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -136,6 +146,9 @@ public final Boolean ignoreMissing() { } /** + * List of keys to filter and insert into document. Defaults to including all + * keys. + *

* API name: {@code include_keys} */ public final List includeKeys() { @@ -143,6 +156,8 @@ public final List includeKeys() { } /** + * Prefix to be added to extracted keys. + *

* API name: {@code prefix} */ @Nullable @@ -151,6 +166,10 @@ public final String prefix() { } /** + * If true. strip brackets (), <>, + * [] as well as quotes ' and " from + * extracted values. + *

* API name: {@code strip_brackets} */ @Nullable @@ -159,6 +178,9 @@ public final Boolean stripBrackets() { } /** + * The field to insert the extracted keys into. Defaults to the root of the + * document. Supports template snippets. + *

* API name: {@code target_field} */ @Nullable @@ -167,6 +189,8 @@ public final String targetField() { } /** + * String of characters to trim from extracted keys. + *

* API name: {@code trim_key} */ @Nullable @@ -175,6 +199,8 @@ public final String trimKey() { } /** + * String of characters to trim from extracted values. + *

* API name: {@code trim_value} */ @Nullable @@ -183,7 +209,10 @@ public final String trimValue() { } /** - * Required - API name: {@code value_split} + * Required - Regex pattern to use for splitting the key from the value within a + * key-value pair. + *

+ * API name: {@code value_split} */ public final String valueSplit() { return this.valueSplit; @@ -293,6 +322,8 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String valueSplit; /** + * List of keys to exclude from document. + *

* API name: {@code exclude_keys} *

* Adds all elements of list to excludeKeys. @@ -303,6 +334,8 @@ public final Builder excludeKeys(List list) { } /** + * List of keys to exclude from document. + *

* API name: {@code exclude_keys} *

* Adds one or more values to excludeKeys. @@ -313,7 +346,9 @@ public final Builder excludeKeys(String value, String... values) { } /** - * Required - API name: {@code field} + * Required - The field to be parsed. Supports template snippets. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -321,7 +356,9 @@ public final Builder field(String value) { } /** - * Required - API name: {@code field_split} + * Required - Regex pattern to use for splitting key-value pairs. + *

+ * API name: {@code field_split} */ public final Builder fieldSplit(String value) { this.fieldSplit = value; @@ -329,6 +366,10 @@ public final Builder fieldSplit(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -337,6 +378,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * List of keys to filter and insert into document. Defaults to including all + * keys. + *

* API name: {@code include_keys} *

* Adds all elements of list to includeKeys. @@ -347,6 +391,9 @@ public final Builder includeKeys(List list) { } /** + * List of keys to filter and insert into document. Defaults to including all + * keys. + *

* API name: {@code include_keys} *

* Adds one or more values to includeKeys. @@ -357,6 +404,8 @@ public final Builder includeKeys(String value, String... values) { } /** + * Prefix to be added to extracted keys. + *

* API name: {@code prefix} */ public final Builder prefix(@Nullable String value) { @@ -365,6 +414,10 @@ public final Builder prefix(@Nullable String value) { } /** + * If true. strip brackets (), <>, + * [] as well as quotes ' and " from + * extracted values. + *

* API name: {@code strip_brackets} */ public final Builder stripBrackets(@Nullable Boolean value) { @@ -373,6 +426,9 @@ public final Builder stripBrackets(@Nullable Boolean value) { } /** + * The field to insert the extracted keys into. Defaults to the root of the + * document. Supports template snippets. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { @@ -381,6 +437,8 @@ public final Builder targetField(@Nullable String value) { } /** + * String of characters to trim from extracted keys. + *

* API name: {@code trim_key} */ public final Builder trimKey(@Nullable String value) { @@ -389,6 +447,8 @@ public final Builder trimKey(@Nullable String value) { } /** + * String of characters to trim from extracted values. + *

* API name: {@code trim_value} */ public final Builder trimValue(@Nullable String value) { @@ -397,7 +457,10 @@ public final Builder trimValue(@Nullable String value) { } /** - * Required - API name: {@code value_split} + * Required - Regex pattern to use for splitting the key from the value within a + * key-value pair. + *

+ * API name: {@code value_split} */ public final Builder valueSplit(String value) { this.valueSplit = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/LowercaseProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/LowercaseProcessor.java index ee9df004b..69021fd3c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/LowercaseProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/LowercaseProcessor.java @@ -79,13 +79,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to make lowercase. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -94,6 +100,9 @@ public final Boolean ignoreMissing() { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -138,7 +147,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field to make lowercase. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -146,6 +157,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -154,6 +169,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Pipeline.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Pipeline.java index 36757dec1..fe250f09a 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Pipeline.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/Pipeline.java @@ -76,6 +76,8 @@ public static Pipeline of(Function> fn) { } /** + * Description of the ingest pipeline. + *

* API name: {@code description} */ @Nullable @@ -84,6 +86,8 @@ public final String description() { } /** + * Processors to run immediately after a processor failure. + *

* API name: {@code on_failure} */ public final List onFailure() { @@ -91,6 +95,9 @@ public final List onFailure() { } /** + * Processors used to perform transformations on documents before indexing. + * Processors run sequentially in the order specified. + *

* API name: {@code processors} */ public final List processors() { @@ -98,6 +105,8 @@ public final List processors() { } /** + * Version number used by external systems to track ingest pipelines. + *

* API name: {@code version} */ @Nullable @@ -174,6 +183,8 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Long version; /** + * Description of the ingest pipeline. + *

* API name: {@code description} */ public final Builder description(@Nullable String value) { @@ -182,6 +193,8 @@ public final Builder description(@Nullable String value) { } /** + * Processors to run immediately after a processor failure. + *

* API name: {@code on_failure} *

* Adds all elements of list to onFailure. @@ -192,6 +205,8 @@ public final Builder onFailure(List list) { } /** + * Processors to run immediately after a processor failure. + *

* API name: {@code on_failure} *

* Adds one or more values to onFailure. @@ -202,6 +217,8 @@ public final Builder onFailure(Processor value, Processor... values) { } /** + * Processors to run immediately after a processor failure. + *

* API name: {@code on_failure} *

* Adds a value to onFailure using a builder lambda. @@ -211,6 +228,9 @@ public final Builder onFailure(Function * API name: {@code processors} *

* Adds all elements of list to processors. @@ -221,6 +241,9 @@ public final Builder processors(List list) { } /** + * Processors used to perform transformations on documents before indexing. + * Processors run sequentially in the order specified. + *

* API name: {@code processors} *

* Adds one or more values to processors. @@ -231,6 +254,9 @@ public final Builder processors(Processor value, Processor... values) { } /** + * Processors used to perform transformations on documents before indexing. + * Processors run sequentially in the order specified. + *

* API name: {@code processors} *

* Adds a value to processors using a builder lambda. @@ -240,6 +266,8 @@ public final Builder processors(Function * API name: {@code version} */ public final Builder version(@Nullable Long value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PipelineProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PipelineProcessor.java index 5b92e62fe..77a2182e1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PipelineProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PipelineProcessor.java @@ -74,13 +74,17 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code name} + * Required - The name of the pipeline to execute. Supports template snippets. + *

+ * API name: {@code name} */ public final String name() { return this.name; } /** + * Whether to ignore missing pipelines instead of failing. + *

* API name: {@code ignore_missing_pipeline} */ @Nullable @@ -117,7 +121,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private Boolean ignoreMissingPipeline; /** - * Required - API name: {@code name} + * Required - The name of the pipeline to execute. Supports template snippets. + *

+ * API name: {@code name} */ public final Builder name(String value) { this.name = value; @@ -125,6 +131,8 @@ public final Builder name(String value) { } /** + * Whether to ignore missing pipelines instead of failing. + *

* API name: {@code ignore_missing_pipeline} */ public final Builder ignoreMissingPipeline(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBase.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBase.java index 26c51d71c..8b4fa3224 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBase.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorBase.java @@ -77,6 +77,9 @@ protected ProcessorBase(AbstractBuilder builder) { } /** + * Description of the processor. Useful for describing the purpose of the + * processor or its configuration. + *

* API name: {@code description} */ @Nullable @@ -85,6 +88,8 @@ public final String description() { } /** + * Conditionally execute the processor. + *

* API name: {@code if} */ @Nullable @@ -93,6 +98,8 @@ public final String if_() { } /** + * Ignore failures for the processor. + *

* API name: {@code ignore_failure} */ @Nullable @@ -101,6 +108,8 @@ public final Boolean ignoreFailure() { } /** + * Handle failures for the processor. + *

* API name: {@code on_failure} */ public final List onFailure() { @@ -108,6 +117,8 @@ public final List onFailure() { } /** + * Identifier for the processor. Useful for debugging and metrics. + *

* API name: {@code tag} */ @Nullable @@ -183,6 +194,9 @@ public abstract static class AbstractBuilder * API name: {@code description} */ public final BuilderT description(@Nullable String value) { @@ -191,6 +205,8 @@ public final BuilderT description(@Nullable String value) { } /** + * Conditionally execute the processor. + *

* API name: {@code if} */ public final BuilderT if_(@Nullable String value) { @@ -199,6 +215,8 @@ public final BuilderT if_(@Nullable String value) { } /** + * Ignore failures for the processor. + *

* API name: {@code ignore_failure} */ public final BuilderT ignoreFailure(@Nullable Boolean value) { @@ -207,6 +225,8 @@ public final BuilderT ignoreFailure(@Nullable Boolean value) { } /** + * Handle failures for the processor. + *

* API name: {@code on_failure} *

* Adds all elements of list to onFailure. @@ -217,6 +237,8 @@ public final BuilderT onFailure(List list) { } /** + * Handle failures for the processor. + *

* API name: {@code on_failure} *

* Adds one or more values to onFailure. @@ -227,6 +249,8 @@ public final BuilderT onFailure(Processor value, Processor... values) { } /** + * Handle failures for the processor. + *

* API name: {@code on_failure} *

* Adds a value to onFailure using a builder lambda. @@ -236,6 +260,8 @@ public final BuilderT onFailure(Function * API name: {@code tag} */ public final BuilderT tag(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorGrokRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorGrokRequest.java index cb6479acc..62df97093 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorGrokRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/ProcessorGrokRequest.java @@ -39,7 +39,10 @@ // typedef: ingest.processor_grok.Request /** - * Returns a list of the built-in patterns. + * Extracts structured fields out of a single text field within a document. You + * choose which field to extract matched fields from, as well as the grok + * pattern you expect will match. A grok pattern is like a regular expression + * that supports aliased expressions that can be reused. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PutPipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PutPipelineRequest.java index 8e27524a9..b7f0d4b5c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PutPipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/PutPipelineRequest.java @@ -50,7 +50,8 @@ // typedef: ingest.put_pipeline.Request /** - * Creates or updates a pipeline. + * Creates or updates an ingest pipeline. Changes made using this API take + * effect immediately. * * @see API * specification diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RemoveProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RemoveProcessor.java index d4ac3dd35..f826b01a9 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RemoveProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RemoveProcessor.java @@ -75,13 +75,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - Fields to be removed. Supports template snippets. + *

+ * API name: {@code field} */ public final List field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -125,7 +131,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private Boolean ignoreMissing; /** - * Required - API name: {@code field} + * Required - Fields to be removed. Supports template snippets. + *

+ * API name: {@code field} *

* Adds all elements of list to field. */ @@ -135,7 +143,9 @@ public final Builder field(List list) { } /** - * Required - API name: {@code field} + * Required - Fields to be removed. Supports template snippets. + *

+ * API name: {@code field} *

* Adds one or more values to field. */ @@ -145,6 +155,10 @@ public final Builder field(String value, String... values) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RenameProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RenameProcessor.java index 87b4d2210..6967424bd 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RenameProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/RenameProcessor.java @@ -77,13 +77,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to be renamed. Supports template snippets. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -92,7 +97,9 @@ public final Boolean ignoreMissing() { } /** - * Required - API name: {@code target_field} + * Required - The new name of the field. Supports template snippets. + *

+ * API name: {@code target_field} */ public final String targetField() { return this.targetField; @@ -131,7 +138,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field to be renamed. Supports template snippets. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -139,6 +148,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -147,7 +159,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** - * Required - API name: {@code target_field} + * Required - The new name of the field. Supports template snippets. + *

+ * API name: {@code target_field} */ public final Builder targetField(String value) { this.targetField = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetProcessor.java index d62ff0e41..af042a9e1 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetProcessor.java @@ -91,6 +91,11 @@ public Processor.Kind _processorKind() { } /** + * The origin field which will be copied to field, cannot set + * value simultaneously. Supported data types are + * boolean, number, array, + * object, string, date, etc. + *

* API name: {@code copy_from} */ @Nullable @@ -99,13 +104,20 @@ public final String copyFrom() { } /** - * Required - API name: {@code field} + * Required - The field to insert, upsert, or update. Supports template + * snippets. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and value is a template snippet that + * evaluates to null or the empty string, the processor quietly + * exits without modifying the document. + *

* API name: {@code ignore_empty_value} */ @Nullable @@ -114,6 +126,10 @@ public final Boolean ignoreEmptyValue() { } /** + * The media type for encoding value. Applies only when value is a + * template snippet. Must be one of application/json, + * text/plain, or application/x-www-form-urlencoded. + *

* API name: {@code media_type} */ @Nullable @@ -122,6 +138,10 @@ public final String mediaType() { } /** + * If true processor will update fields with pre-existing + * non-null-valued field. When set to false, such fields will not + * be touched. + *

* API name: {@code override} */ @Nullable @@ -130,6 +150,9 @@ public final Boolean override() { } /** + * The value to be set for the field. Supports template snippets. May specify + * only one of value or copy_from. + *

* API name: {@code value} */ @Nullable @@ -196,6 +219,11 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private JsonData value; /** + * The origin field which will be copied to field, cannot set + * value simultaneously. Supported data types are + * boolean, number, array, + * object, string, date, etc. + *

* API name: {@code copy_from} */ public final Builder copyFrom(@Nullable String value) { @@ -204,7 +232,10 @@ public final Builder copyFrom(@Nullable String value) { } /** - * Required - API name: {@code field} + * Required - The field to insert, upsert, or update. Supports template + * snippets. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -212,6 +243,10 @@ public final Builder field(String value) { } /** + * If true and value is a template snippet that + * evaluates to null or the empty string, the processor quietly + * exits without modifying the document. + *

* API name: {@code ignore_empty_value} */ public final Builder ignoreEmptyValue(@Nullable Boolean value) { @@ -220,6 +255,10 @@ public final Builder ignoreEmptyValue(@Nullable Boolean value) { } /** + * The media type for encoding value. Applies only when value is a + * template snippet. Must be one of application/json, + * text/plain, or application/x-www-form-urlencoded. + *

* API name: {@code media_type} */ public final Builder mediaType(@Nullable String value) { @@ -228,6 +267,10 @@ public final Builder mediaType(@Nullable String value) { } /** + * If true processor will update fields with pre-existing + * non-null-valued field. When set to false, such fields will not + * be touched. + *

* API name: {@code override} */ public final Builder override(@Nullable Boolean value) { @@ -236,6 +279,9 @@ public final Builder override(@Nullable Boolean value) { } /** + * The value to be set for the field. Supports template snippets. May specify + * only one of value or copy_from. + *

* API name: {@code value} */ public final Builder value(@Nullable JsonData value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetSecurityUserProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetSecurityUserProcessor.java index 4d03c47f2..4c17a574f 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetSecurityUserProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SetSecurityUserProcessor.java @@ -74,13 +74,17 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to store the user information into. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * Controls what user related properties are added to the field. + *

* API name: {@code properties} */ public final List properties() { @@ -121,7 +125,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private List properties; /** - * Required - API name: {@code field} + * Required - The field to store the user information into. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -129,6 +135,8 @@ public final Builder field(String value) { } /** + * Controls what user related properties are added to the field. + *

* API name: {@code properties} *

* Adds all elements of list to properties. @@ -139,6 +147,8 @@ public final Builder properties(List list) { } /** + * Controls what user related properties are added to the field. + *

* API name: {@code properties} *

* Adds one or more values to properties. diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SimulateRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SimulateRequest.java index abe26484d..89c4eb653 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SimulateRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SimulateRequest.java @@ -49,7 +49,7 @@ // typedef: ingest.simulate.Request /** - * Allows to simulate a pipeline with example documents. + * Executes an ingest pipeline against a set of provided documents. * * @see API * specification @@ -83,6 +83,8 @@ public static SimulateRequest of(Function * API name: {@code docs} */ public final List docs() { @@ -90,7 +92,8 @@ public final List docs() { } /** - * Pipeline ID + * Pipeline to test. If you don’t specify a pipeline in the request + * body, this parameter is required. *

* API name: {@code id} */ @@ -100,6 +103,10 @@ public final String id() { } /** + * Pipeline to test. If you don’t specify the pipeline request path + * parameter, this parameter is required. If you specify both this and the + * request path parameter, the API only uses the request path parameter. + *

* API name: {@code pipeline} */ @Nullable @@ -108,7 +115,8 @@ public final Pipeline pipeline() { } /** - * Verbose mode. Display data output for each processor in executed pipeline + * If true, the response includes output data for each processor in + * the executed pipeline. *

* API name: {@code verbose} */ @@ -166,6 +174,8 @@ public static class Builder extends RequestBase.AbstractBuilder impleme private Boolean verbose; /** + * Sample documents to test in the pipeline. + *

* API name: {@code docs} *

* Adds all elements of list to docs. @@ -176,6 +186,8 @@ public final Builder docs(List list) { } /** + * Sample documents to test in the pipeline. + *

* API name: {@code docs} *

* Adds one or more values to docs. @@ -186,6 +198,8 @@ public final Builder docs(Document value, Document... values) { } /** + * Sample documents to test in the pipeline. + *

* API name: {@code docs} *

* Adds a value to docs using a builder lambda. @@ -195,7 +209,8 @@ public final Builder docs(Function> fn } /** - * Pipeline ID + * Pipeline to test. If you don’t specify a pipeline in the request + * body, this parameter is required. *

* API name: {@code id} */ @@ -205,6 +220,10 @@ public final Builder id(@Nullable String value) { } /** + * Pipeline to test. If you don’t specify the pipeline request path + * parameter, this parameter is required. If you specify both this and the + * request path parameter, the API only uses the request path parameter. + *

* API name: {@code pipeline} */ public final Builder pipeline(@Nullable Pipeline value) { @@ -213,6 +232,10 @@ public final Builder pipeline(@Nullable Pipeline value) { } /** + * Pipeline to test. If you don’t specify the pipeline request path + * parameter, this parameter is required. If you specify both this and the + * request path parameter, the API only uses the request path parameter. + *

* API name: {@code pipeline} */ public final Builder pipeline(Function> fn) { @@ -220,7 +243,8 @@ public final Builder pipeline(Function } /** - * Verbose mode. Display data output for each processor in executed pipeline + * If true, the response includes output data for each processor in + * the executed pipeline. *

* API name: {@code verbose} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SortProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SortProcessor.java index e75d33dc3..e18f716a8 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SortProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SortProcessor.java @@ -78,13 +78,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to be sorted. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * The sort order to use. Accepts "asc" or + * "desc". + *

* API name: {@code order} */ @Nullable @@ -93,6 +98,9 @@ public final SortOrder order() { } /** + * The field to assign the sorted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -134,7 +142,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String targetField; /** - * Required - API name: {@code field} + * Required - The field to be sorted. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -142,6 +152,9 @@ public final Builder field(String value) { } /** + * The sort order to use. Accepts "asc" or + * "desc". + *

* API name: {@code order} */ public final Builder order(@Nullable SortOrder value) { @@ -150,6 +163,9 @@ public final Builder order(@Nullable SortOrder value) { } /** + * The field to assign the sorted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SplitProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SplitProcessor.java index 2b64078cd..0ba04466e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SplitProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/SplitProcessor.java @@ -85,13 +85,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to split. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -100,6 +105,8 @@ public final Boolean ignoreMissing() { } /** + * Preserves empty trailing fields, if any. + *

* API name: {@code preserve_trailing} */ @Nullable @@ -108,13 +115,19 @@ public final Boolean preserveTrailing() { } /** - * Required - API name: {@code separator} + * Required - A regex which matches the separator, for example, , + * or \s+. + *

+ * API name: {@code separator} */ public final String separator() { return this.separator; } /** + * The field to assign the split value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -172,7 +185,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field to split. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -180,6 +195,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -188,6 +206,8 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * Preserves empty trailing fields, if any. + *

* API name: {@code preserve_trailing} */ public final Builder preserveTrailing(@Nullable Boolean value) { @@ -196,7 +216,10 @@ public final Builder preserveTrailing(@Nullable Boolean value) { } /** - * Required - API name: {@code separator} + * Required - A regex which matches the separator, for example, , + * or \s+. + *

+ * API name: {@code separator} */ public final Builder separator(String value) { this.separator = value; @@ -204,6 +227,9 @@ public final Builder separator(String value) { } /** + * The field to assign the split value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/TrimProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/TrimProcessor.java index fd02566f9..2929330e3 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/TrimProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/TrimProcessor.java @@ -78,13 +78,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The string-valued field to trim whitespace from. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -93,6 +98,9 @@ public final Boolean ignoreMissing() { } /** + * The field to assign the trimmed value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -135,7 +143,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder imple private String targetField; /** - * Required - API name: {@code field} + * Required - The string-valued field to trim whitespace from. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -143,6 +153,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -151,6 +164,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The field to assign the trimmed value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UppercaseProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UppercaseProcessor.java index 17837e874..8c0adeab2 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UppercaseProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UppercaseProcessor.java @@ -79,13 +79,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to make uppercase. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -94,6 +100,9 @@ public final Boolean ignoreMissing() { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -138,7 +147,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field to make uppercase. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -146,6 +157,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -154,6 +169,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UrlDecodeProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UrlDecodeProcessor.java index 8661fc4b2..f83d15a77 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UrlDecodeProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UrlDecodeProcessor.java @@ -79,13 +79,19 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field to decode. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -94,6 +100,9 @@ public final Boolean ignoreMissing() { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ @Nullable @@ -138,7 +147,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field to decode. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -146,6 +157,10 @@ public final Builder field(String value) { } /** + * If true and field does not exist or is + * null, the processor quietly exits without modifying the + * document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -154,6 +169,9 @@ public final Builder ignoreMissing(@Nullable Boolean value) { } /** + * The field to assign the converted value to. By default, the field is updated + * in-place. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UserAgentProcessor.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UserAgentProcessor.java index f7459e5c1..997207ee9 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UserAgentProcessor.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/UserAgentProcessor.java @@ -87,13 +87,18 @@ public Processor.Kind _processorKind() { } /** - * Required - API name: {@code field} + * Required - The field containing the user agent string. + *

+ * API name: {@code field} */ public final String field() { return this.field; } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ @Nullable @@ -109,6 +114,12 @@ public final List options() { } /** + * The name of the file in the config/ingest-user-agent directory + * containing the regular expressions for parsing the user agent string. Both + * the directory and the file have to be created before starting Elasticsearch. + * If not specified, ingest-user-agent will use the regexes.yaml + * from uap-core it ships with. + *

* API name: {@code regex_file} */ @Nullable @@ -117,6 +128,8 @@ public final String regexFile() { } /** + * The field that will be filled with the user agent details. + *

* API name: {@code target_field} */ @Nullable @@ -181,7 +194,9 @@ public static class Builder extends ProcessorBase.AbstractBuilder private String targetField; /** - * Required - API name: {@code field} + * Required - The field containing the user agent string. + *

+ * API name: {@code field} */ public final Builder field(String value) { this.field = value; @@ -189,6 +204,9 @@ public final Builder field(String value) { } /** + * If true and field does not exist, the processor + * quietly exits without modifying the document. + *

* API name: {@code ignore_missing} */ public final Builder ignoreMissing(@Nullable Boolean value) { @@ -217,6 +235,12 @@ public final Builder options(UserAgentProperty value, UserAgentProperty... value } /** + * The name of the file in the config/ingest-user-agent directory + * containing the regular expressions for parsing the user agent string. Both + * the directory and the file have to be created before starting Elasticsearch. + * If not specified, ingest-user-agent will use the regexes.yaml + * from uap-core it ships with. + *

* API name: {@code regex_file} */ public final Builder regexFile(@Nullable String value) { @@ -225,6 +249,8 @@ public final Builder regexFile(@Nullable String value) { } /** + * The field that will be filled with the user agent details. + *

* API name: {@code target_field} */ public final Builder targetField(@Nullable String value) { diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/Document.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/Document.java index 53a8ecab9..07d8e28d7 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/Document.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/Document.java @@ -72,6 +72,9 @@ public static Document of(Function> fn) { } /** + * Unique identifier for the document. This ID must be unique within the + * _index. + *

* API name: {@code _id} */ @Nullable @@ -80,6 +83,8 @@ public final String id() { } /** + * Name of the index containing the document. + *

* API name: {@code _index} */ @Nullable @@ -88,7 +93,9 @@ public final String index() { } /** - * Required - API name: {@code _source} + * Required - JSON body for the document. + *

+ * API name: {@code _source} */ public final JsonData source() { return this.source; @@ -141,6 +148,9 @@ public static class Builder extends WithJsonObjectBuilderBase implement private JsonData source; /** + * Unique identifier for the document. This ID must be unique within the + * _index. + *

* API name: {@code _id} */ public final Builder id(@Nullable String value) { @@ -149,6 +159,8 @@ public final Builder id(@Nullable String value) { } /** + * Name of the index containing the document. + *

* API name: {@code _index} */ public final Builder index(@Nullable String value) { @@ -157,7 +169,9 @@ public final Builder index(@Nullable String value) { } /** - * Required - API name: {@code _source} + * Required - JSON body for the document. + *

+ * API name: {@code _source} */ public final Builder source(JsonData value) { this.source = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/DocumentSimulation.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/DocumentSimulation.java index 3ee964b5f..528af0840 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/DocumentSimulation.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/ingest/simulate/DocumentSimulation.java @@ -102,14 +102,19 @@ public final Map metadata() { } /** - * Required - API name: {@code _id} + * Required - Unique identifier for the document. This ID must be unique within + * the _index. + *

+ * API name: {@code _id} */ public final String id() { return this.id; } /** - * Required - API name: {@code _index} + * Required - Name of the index containing the document. + *

+ * API name: {@code _index} */ public final String index() { return this.index; @@ -123,6 +128,8 @@ public final Ingest ingest() { } /** + * Value used to send the document to a specific primary shard. + *

* API name: {@code _routing} */ @Nullable @@ -131,7 +138,9 @@ public final String routing() { } /** - * Required - API name: {@code _source} + * Required - JSON body for the document. + *

+ * API name: {@code _source} */ public final Map source() { return this.source; @@ -262,7 +271,10 @@ public final Builder metadata(String key, String value) { private VersionType versionType; /** - * Required - API name: {@code _id} + * Required - Unique identifier for the document. This ID must be unique within + * the _index. + *

+ * API name: {@code _id} */ public final Builder id(String value) { this.id = value; @@ -270,7 +282,9 @@ public final Builder id(String value) { } /** - * Required - API name: {@code _index} + * Required - Name of the index containing the document. + *

+ * API name: {@code _index} */ public final Builder index(String value) { this.index = value; @@ -293,6 +307,8 @@ public final Builder ingest(Function> fn) } /** + * Value used to send the document to a specific primary shard. + *

* API name: {@code _routing} */ public final Builder routing(@Nullable String value) { @@ -301,7 +317,9 @@ public final Builder routing(@Nullable String value) { } /** - * Required - API name: {@code _source} + * Required - JSON body for the document. + *

+ * API name: {@code _source} *

* Adds all entries of map to source. */ @@ -311,7 +329,9 @@ public final Builder source(Map map) { } /** - * Required - API name: {@code _source} + * Required - JSON body for the document. + *

+ * API name: {@code _source} *

* Adds an entry to source. */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/DeletePipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/DeletePipelineRequest.java index 24708dc48..ef677f17e 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/DeletePipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/DeletePipelineRequest.java @@ -47,7 +47,7 @@ // typedef: logstash.delete_pipeline.Request /** - * Deletes Logstash Pipelines used by Central Management + * Deletes a pipeline used for Logstash Central Management. * * @see API @@ -70,7 +70,7 @@ public static DeletePipelineRequest of(Function * API name: {@code id} */ @@ -90,7 +90,7 @@ public static class Builder extends RequestBase.AbstractBuilder private String id; /** - * Required - The ID of the Pipeline + * Required - Identifier for the pipeline. *

* API name: {@code id} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/GetPipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/GetPipelineRequest.java index bb5cfcf38..2f19bfd8c 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/GetPipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/GetPipelineRequest.java @@ -47,7 +47,7 @@ // typedef: logstash.get_pipeline.Request /** - * Retrieves Logstash Pipelines used by Central Management + * Retrieves pipelines used for Logstash Central Management. * * @see API * specification @@ -69,7 +69,7 @@ public static GetPipelineRequest of(Function * API name: {@code id} */ @@ -89,7 +89,7 @@ public static class Builder extends RequestBase.AbstractBuilder private List id; /** - * Required - A comma-separated list of Pipeline IDs + * Required - Comma-separated list of pipeline identifiers. *

* API name: {@code id} *

@@ -101,7 +101,7 @@ public final Builder id(List list) { } /** - * Required - A comma-separated list of Pipeline IDs + * Required - Comma-separated list of pipeline identifiers. *

* API name: {@code id} *

diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/Pipeline.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/Pipeline.java index 47337e403..ba1b1b674 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/Pipeline.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/Pipeline.java @@ -79,42 +79,58 @@ public static Pipeline of(Function> fn) { } /** - * Required - API name: {@code description} + * Required - Description of the pipeline. This description is not used by + * Elasticsearch or Logstash. + *

+ * API name: {@code description} */ public final String description() { return this.description; } /** - * Required - API name: {@code last_modified} + * Required - Date the pipeline was last updated. Must be in the + * yyyy-MM-dd'T'HH:mm:ss.SSSZZ strict_date_time format. + *

+ * API name: {@code last_modified} */ public final DateTime lastModified() { return this.lastModified; } /** - * Required - API name: {@code pipeline_metadata} + * Required - Optional metadata about the pipeline. May have any contents. This + * metadata is not generated or used by Elasticsearch or Logstash. + *

+ * API name: {@code pipeline_metadata} */ public final PipelineMetadata pipelineMetadata() { return this.pipelineMetadata; } /** - * Required - API name: {@code username} + * Required - User who last updated the pipeline. + *

+ * API name: {@code username} */ public final String username() { return this.username; } /** - * Required - API name: {@code pipeline} + * Required - Configuration for the pipeline. + *

+ * API name: {@code pipeline} */ public final String pipeline() { return this.pipeline; } /** - * Required - API name: {@code pipeline_settings} + * Required - Settings for the pipeline. Supports only flat keys in dot + * notation. + *

+ * API name: {@code pipeline_settings} */ public final PipelineSettings pipelineSettings() { return this.pipelineSettings; @@ -175,7 +191,10 @@ public static class Builder extends WithJsonObjectBuilderBase implement private PipelineSettings pipelineSettings; /** - * Required - API name: {@code description} + * Required - Description of the pipeline. This description is not used by + * Elasticsearch or Logstash. + *

+ * API name: {@code description} */ public final Builder description(String value) { this.description = value; @@ -183,7 +202,10 @@ public final Builder description(String value) { } /** - * Required - API name: {@code last_modified} + * Required - Date the pipeline was last updated. Must be in the + * yyyy-MM-dd'T'HH:mm:ss.SSSZZ strict_date_time format. + *

+ * API name: {@code last_modified} */ public final Builder lastModified(DateTime value) { this.lastModified = value; @@ -191,7 +213,10 @@ public final Builder lastModified(DateTime value) { } /** - * Required - API name: {@code pipeline_metadata} + * Required - Optional metadata about the pipeline. May have any contents. This + * metadata is not generated or used by Elasticsearch or Logstash. + *

+ * API name: {@code pipeline_metadata} */ public final Builder pipelineMetadata(PipelineMetadata value) { this.pipelineMetadata = value; @@ -199,14 +224,19 @@ public final Builder pipelineMetadata(PipelineMetadata value) { } /** - * Required - API name: {@code pipeline_metadata} + * Required - Optional metadata about the pipeline. May have any contents. This + * metadata is not generated or used by Elasticsearch or Logstash. + *

+ * API name: {@code pipeline_metadata} */ public final Builder pipelineMetadata(Function> fn) { return this.pipelineMetadata(fn.apply(new PipelineMetadata.Builder()).build()); } /** - * Required - API name: {@code username} + * Required - User who last updated the pipeline. + *

+ * API name: {@code username} */ public final Builder username(String value) { this.username = value; @@ -214,7 +244,9 @@ public final Builder username(String value) { } /** - * Required - API name: {@code pipeline} + * Required - Configuration for the pipeline. + *

+ * API name: {@code pipeline} */ public final Builder pipeline(String value) { this.pipeline = value; @@ -222,7 +254,10 @@ public final Builder pipeline(String value) { } /** - * Required - API name: {@code pipeline_settings} + * Required - Settings for the pipeline. Supports only flat keys in dot + * notation. + *

+ * API name: {@code pipeline_settings} */ public final Builder pipelineSettings(PipelineSettings value) { this.pipelineSettings = value; @@ -230,7 +265,10 @@ public final Builder pipelineSettings(PipelineSettings value) { } /** - * Required - API name: {@code pipeline_settings} + * Required - Settings for the pipeline. Supports only flat keys in dot + * notation. + *

+ * API name: {@code pipeline_settings} */ public final Builder pipelineSettings(Function> fn) { return this.pipelineSettings(fn.apply(new PipelineSettings.Builder()).build()); diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PipelineSettings.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PipelineSettings.java index f35a364b4..4db7c0c6d 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PipelineSettings.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PipelineSettings.java @@ -85,49 +85,70 @@ public static PipelineSettings of(Function + * API name: {@code pipeline.workers} */ public final int pipelineWorkers() { return this.pipelineWorkers; } /** - * Required - API name: {@code pipeline.batch.size} + * Required - The maximum number of events an individual worker thread will + * collect from inputs before attempting to execute its filters and outputs. + *

+ * API name: {@code pipeline.batch.size} */ public final int pipelineBatchSize() { return this.pipelineBatchSize; } /** - * Required - API name: {@code pipeline.batch.delay} + * Required - When creating pipeline event batches, how long in milliseconds to + * wait for each event before dispatching an undersized batch to pipeline + * workers. + *

+ * API name: {@code pipeline.batch.delay} */ public final int pipelineBatchDelay() { return this.pipelineBatchDelay; } /** - * Required - API name: {@code queue.type} + * Required - The internal queuing model to use for event buffering. + *

+ * API name: {@code queue.type} */ public final String queueType() { return this.queueType; } /** - * Required - API name: {@code queue.max_bytes.number} + * Required - The total capacity of the queue + * (queue.type: persisted) in number of bytes. + *

+ * API name: {@code queue.max_bytes.number} */ public final int queueMaxBytesNumber() { return this.queueMaxBytesNumber; } /** - * Required - API name: {@code queue.max_bytes.units} + * Required - The total capacity of the queue + * (queue.type: persisted) in terms of units of bytes. + *

+ * API name: {@code queue.max_bytes.units} */ public final String queueMaxBytesUnits() { return this.queueMaxBytesUnits; } /** - * Required - API name: {@code queue.checkpoint.writes} + * Required - The maximum number of written events before forcing a checkpoint + * when persistent queues are enabled (queue.type: persisted). + *

+ * API name: {@code queue.checkpoint.writes} */ public final int queueCheckpointWrites() { return this.queueCheckpointWrites; @@ -194,7 +215,10 @@ public static class Builder extends WithJsonObjectBuilderBase implement private Integer queueCheckpointWrites; /** - * Required - API name: {@code pipeline.workers} + * Required - The number of workers that will, in parallel, execute the filter + * and output stages of the pipeline. + *

+ * API name: {@code pipeline.workers} */ public final Builder pipelineWorkers(int value) { this.pipelineWorkers = value; @@ -202,7 +226,10 @@ public final Builder pipelineWorkers(int value) { } /** - * Required - API name: {@code pipeline.batch.size} + * Required - The maximum number of events an individual worker thread will + * collect from inputs before attempting to execute its filters and outputs. + *

+ * API name: {@code pipeline.batch.size} */ public final Builder pipelineBatchSize(int value) { this.pipelineBatchSize = value; @@ -210,7 +237,11 @@ public final Builder pipelineBatchSize(int value) { } /** - * Required - API name: {@code pipeline.batch.delay} + * Required - When creating pipeline event batches, how long in milliseconds to + * wait for each event before dispatching an undersized batch to pipeline + * workers. + *

+ * API name: {@code pipeline.batch.delay} */ public final Builder pipelineBatchDelay(int value) { this.pipelineBatchDelay = value; @@ -218,7 +249,9 @@ public final Builder pipelineBatchDelay(int value) { } /** - * Required - API name: {@code queue.type} + * Required - The internal queuing model to use for event buffering. + *

+ * API name: {@code queue.type} */ public final Builder queueType(String value) { this.queueType = value; @@ -226,7 +259,10 @@ public final Builder queueType(String value) { } /** - * Required - API name: {@code queue.max_bytes.number} + * Required - The total capacity of the queue + * (queue.type: persisted) in number of bytes. + *

+ * API name: {@code queue.max_bytes.number} */ public final Builder queueMaxBytesNumber(int value) { this.queueMaxBytesNumber = value; @@ -234,7 +270,10 @@ public final Builder queueMaxBytesNumber(int value) { } /** - * Required - API name: {@code queue.max_bytes.units} + * Required - The total capacity of the queue + * (queue.type: persisted) in terms of units of bytes. + *

+ * API name: {@code queue.max_bytes.units} */ public final Builder queueMaxBytesUnits(String value) { this.queueMaxBytesUnits = value; @@ -242,7 +281,10 @@ public final Builder queueMaxBytesUnits(String value) { } /** - * Required - API name: {@code queue.checkpoint.writes} + * Required - The maximum number of written events before forcing a checkpoint + * when persistent queues are enabled (queue.type: persisted). + *

+ * API name: {@code queue.checkpoint.writes} */ public final Builder queueCheckpointWrites(int value) { this.queueCheckpointWrites = value; diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PutPipelineRequest.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PutPipelineRequest.java index ed6d1939c..c91287d86 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PutPipelineRequest.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/logstash/PutPipelineRequest.java @@ -50,7 +50,7 @@ // typedef: logstash.put_pipeline.Request /** - * Adds and updates Logstash Pipelines used for Central Management + * Creates or updates a pipeline used for Logstash Central Management. * * @see API * specification @@ -75,7 +75,7 @@ public static PutPipelineRequest of(Function * API name: {@code id} */ @@ -112,7 +112,7 @@ public static class Builder extends RequestBase.AbstractBuilder private Pipeline pipeline; /** - * Required - The ID of the Pipeline + * Required - Identifier for the pipeline. *

* API name: {@code id} */ diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/GetTasksResponse.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/GetTasksResponse.java index f5a6c0093..5046d5053 100644 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/GetTasksResponse.java +++ b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/GetTasksResponse.java @@ -24,6 +24,7 @@ package co.elastic.clients.elasticsearch.tasks; import co.elastic.clients.elasticsearch._types.ErrorCause; +import co.elastic.clients.json.JsonData; import co.elastic.clients.json.JsonpDeserializable; import co.elastic.clients.json.JsonpDeserializer; import co.elastic.clients.json.JsonpMapper; @@ -54,7 +55,7 @@ public class GetTasksResponse implements JsonpSerializable { private final TaskInfo task; @Nullable - private final TaskStatus response; + private final JsonData response; @Nullable private final ErrorCause error; @@ -92,7 +93,7 @@ public final TaskInfo task() { * API name: {@code response} */ @Nullable - public final TaskStatus response() { + public final JsonData response() { return this.response; } @@ -151,7 +152,7 @@ public static class Builder extends WithJsonObjectBuilderBase implement private TaskInfo task; @Nullable - private TaskStatus response; + private JsonData response; @Nullable private ErrorCause error; @@ -182,18 +183,11 @@ public final Builder task(Function> fn /** * API name: {@code response} */ - public final Builder response(@Nullable TaskStatus value) { + public final Builder response(@Nullable JsonData value) { this.response = value; return this; } - /** - * API name: {@code response} - */ - public final Builder response(Function> fn) { - return this.response(fn.apply(new TaskStatus.Builder()).build()); - } - /** * API name: {@code error} */ @@ -239,7 +233,7 @@ protected static void setupGetTasksResponseDeserializer(ObjectDeserializer * API name: {@code status} */ @Nullable - public final TaskStatus status() { + public final JsonData status() { return this.status; } @@ -331,7 +334,7 @@ public abstract static class AbstractBuilder * API name: {@code status} */ - public final BuilderT status(@Nullable TaskStatus value) { + public final BuilderT status(@Nullable JsonData value) { this.status = value; return self(); } - /** - * API name: {@code status} - */ - public final BuilderT status(Function> fn) { - return this.status(fn.apply(new TaskStatus.Builder()).build()); - } - /** * Required - API name: {@code type} */ @@ -494,7 +492,7 @@ protected static > void setupTaskInfo op.add(AbstractBuilder::runningTime, Time._DESERIALIZER, "running_time"); op.add(AbstractBuilder::runningTimeInNanos, JsonpDeserializer.longDeserializer(), "running_time_in_nanos"); op.add(AbstractBuilder::startTimeInMillis, JsonpDeserializer.longDeserializer(), "start_time_in_millis"); - op.add(AbstractBuilder::status, TaskStatus._DESERIALIZER, "status"); + op.add(AbstractBuilder::status, JsonData._DESERIALIZER, "status"); op.add(AbstractBuilder::type, JsonpDeserializer.stringDeserializer(), "type"); op.add(AbstractBuilder::parentTaskId, JsonpDeserializer.stringDeserializer(), "parent_task_id"); diff --git a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/TaskStatus.java b/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/TaskStatus.java deleted file mode 100644 index b63c341f6..000000000 --- a/java-client/src/main/java/co/elastic/clients/elasticsearch/tasks/TaskStatus.java +++ /dev/null @@ -1,600 +0,0 @@ -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -//---------------------------------------------------- -// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST. -//---------------------------------------------------- - -package co.elastic.clients.elasticsearch.tasks; - -import co.elastic.clients.elasticsearch._types.Retries; -import co.elastic.clients.elasticsearch._types.Time; -import co.elastic.clients.json.JsonpDeserializable; -import co.elastic.clients.json.JsonpDeserializer; -import co.elastic.clients.json.JsonpMapper; -import co.elastic.clients.json.JsonpSerializable; -import co.elastic.clients.json.JsonpUtils; -import co.elastic.clients.json.ObjectBuilderDeserializer; -import co.elastic.clients.json.ObjectDeserializer; -import co.elastic.clients.util.ApiTypeHelper; -import co.elastic.clients.util.ObjectBuilder; -import co.elastic.clients.util.WithJsonObjectBuilderBase; -import jakarta.json.stream.JsonGenerator; -import java.lang.Boolean; -import java.lang.Float; -import java.lang.Long; -import java.lang.String; -import java.util.List; -import java.util.Objects; -import java.util.function.Function; -import javax.annotation.Nullable; - -// typedef: tasks._types.TaskStatus - -/** - * - * @see API - * specification - */ -@JsonpDeserializable -public class TaskStatus implements JsonpSerializable { - private final long batches; - - @Nullable - private final String canceled; - - private final long created; - - private final long deleted; - - private final long noops; - - private final List failures; - - private final float requestsPerSecond; - - private final Retries retries; - - @Nullable - private final Time throttled; - - private final long throttledMillis; - - @Nullable - private final Time throttledUntil; - - private final long throttledUntilMillis; - - @Nullable - private final Boolean timedOut; - - @Nullable - private final Long took; - - private final long total; - - private final long updated; - - private final long versionConflicts; - - // --------------------------------------------------------------------------------------------- - - private TaskStatus(Builder builder) { - - this.batches = ApiTypeHelper.requireNonNull(builder.batches, this, "batches"); - this.canceled = builder.canceled; - this.created = ApiTypeHelper.requireNonNull(builder.created, this, "created"); - this.deleted = ApiTypeHelper.requireNonNull(builder.deleted, this, "deleted"); - this.noops = ApiTypeHelper.requireNonNull(builder.noops, this, "noops"); - this.failures = ApiTypeHelper.unmodifiable(builder.failures); - this.requestsPerSecond = ApiTypeHelper.requireNonNull(builder.requestsPerSecond, this, "requestsPerSecond"); - this.retries = ApiTypeHelper.requireNonNull(builder.retries, this, "retries"); - this.throttled = builder.throttled; - this.throttledMillis = ApiTypeHelper.requireNonNull(builder.throttledMillis, this, "throttledMillis"); - this.throttledUntil = builder.throttledUntil; - this.throttledUntilMillis = ApiTypeHelper.requireNonNull(builder.throttledUntilMillis, this, - "throttledUntilMillis"); - this.timedOut = builder.timedOut; - this.took = builder.took; - this.total = ApiTypeHelper.requireNonNull(builder.total, this, "total"); - this.updated = ApiTypeHelper.requireNonNull(builder.updated, this, "updated"); - this.versionConflicts = ApiTypeHelper.requireNonNull(builder.versionConflicts, this, "versionConflicts"); - - } - - public static TaskStatus of(Function> fn) { - return fn.apply(new Builder()).build(); - } - - /** - * Required - API name: {@code batches} - */ - public final long batches() { - return this.batches; - } - - /** - * API name: {@code canceled} - */ - @Nullable - public final String canceled() { - return this.canceled; - } - - /** - * Required - API name: {@code created} - */ - public final long created() { - return this.created; - } - - /** - * Required - API name: {@code deleted} - */ - public final long deleted() { - return this.deleted; - } - - /** - * Required - API name: {@code noops} - */ - public final long noops() { - return this.noops; - } - - /** - * API name: {@code failures} - */ - public final List failures() { - return this.failures; - } - - /** - * Required - API name: {@code requests_per_second} - */ - public final float requestsPerSecond() { - return this.requestsPerSecond; - } - - /** - * Required - API name: {@code retries} - */ - public final Retries retries() { - return this.retries; - } - - /** - * API name: {@code throttled} - */ - @Nullable - public final Time throttled() { - return this.throttled; - } - - /** - * Required - API name: {@code throttled_millis} - */ - public final long throttledMillis() { - return this.throttledMillis; - } - - /** - * API name: {@code throttled_until} - */ - @Nullable - public final Time throttledUntil() { - return this.throttledUntil; - } - - /** - * Required - API name: {@code throttled_until_millis} - */ - public final long throttledUntilMillis() { - return this.throttledUntilMillis; - } - - /** - * API name: {@code timed_out} - */ - @Nullable - public final Boolean timedOut() { - return this.timedOut; - } - - /** - * API name: {@code took} - */ - @Nullable - public final Long took() { - return this.took; - } - - /** - * Required - API name: {@code total} - */ - public final long total() { - return this.total; - } - - /** - * Required - API name: {@code updated} - */ - public final long updated() { - return this.updated; - } - - /** - * Required - API name: {@code version_conflicts} - */ - public final long versionConflicts() { - return this.versionConflicts; - } - - /** - * Serialize this object to JSON. - */ - public void serialize(JsonGenerator generator, JsonpMapper mapper) { - generator.writeStartObject(); - serializeInternal(generator, mapper); - generator.writeEnd(); - } - - protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { - - generator.writeKey("batches"); - generator.write(this.batches); - - if (this.canceled != null) { - generator.writeKey("canceled"); - generator.write(this.canceled); - - } - generator.writeKey("created"); - generator.write(this.created); - - generator.writeKey("deleted"); - generator.write(this.deleted); - - generator.writeKey("noops"); - generator.write(this.noops); - - if (ApiTypeHelper.isDefined(this.failures)) { - generator.writeKey("failures"); - generator.writeStartArray(); - for (String item0 : this.failures) { - generator.write(item0); - - } - generator.writeEnd(); - - } - generator.writeKey("requests_per_second"); - generator.write(this.requestsPerSecond); - - generator.writeKey("retries"); - this.retries.serialize(generator, mapper); - - if (this.throttled != null) { - generator.writeKey("throttled"); - this.throttled.serialize(generator, mapper); - - } - generator.writeKey("throttled_millis"); - generator.write(this.throttledMillis); - - if (this.throttledUntil != null) { - generator.writeKey("throttled_until"); - this.throttledUntil.serialize(generator, mapper); - - } - generator.writeKey("throttled_until_millis"); - generator.write(this.throttledUntilMillis); - - if (this.timedOut != null) { - generator.writeKey("timed_out"); - generator.write(this.timedOut); - - } - if (this.took != null) { - generator.writeKey("took"); - generator.write(this.took); - - } - generator.writeKey("total"); - generator.write(this.total); - - generator.writeKey("updated"); - generator.write(this.updated); - - generator.writeKey("version_conflicts"); - generator.write(this.versionConflicts); - - } - - @Override - public String toString() { - return JsonpUtils.toString(this); - } - - // --------------------------------------------------------------------------------------------- - - /** - * Builder for {@link TaskStatus}. - */ - - public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder { - private Long batches; - - @Nullable - private String canceled; - - private Long created; - - private Long deleted; - - private Long noops; - - @Nullable - private List failures; - - private Float requestsPerSecond; - - private Retries retries; - - @Nullable - private Time throttled; - - private Long throttledMillis; - - @Nullable - private Time throttledUntil; - - private Long throttledUntilMillis; - - @Nullable - private Boolean timedOut; - - @Nullable - private Long took; - - private Long total; - - private Long updated; - - private Long versionConflicts; - - /** - * Required - API name: {@code batches} - */ - public final Builder batches(long value) { - this.batches = value; - return this; - } - - /** - * API name: {@code canceled} - */ - public final Builder canceled(@Nullable String value) { - this.canceled = value; - return this; - } - - /** - * Required - API name: {@code created} - */ - public final Builder created(long value) { - this.created = value; - return this; - } - - /** - * Required - API name: {@code deleted} - */ - public final Builder deleted(long value) { - this.deleted = value; - return this; - } - - /** - * Required - API name: {@code noops} - */ - public final Builder noops(long value) { - this.noops = value; - return this; - } - - /** - * API name: {@code failures} - *

- * Adds all elements of list to failures. - */ - public final Builder failures(List list) { - this.failures = _listAddAll(this.failures, list); - return this; - } - - /** - * API name: {@code failures} - *

- * Adds one or more values to failures. - */ - public final Builder failures(String value, String... values) { - this.failures = _listAdd(this.failures, value, values); - return this; - } - - /** - * Required - API name: {@code requests_per_second} - */ - public final Builder requestsPerSecond(float value) { - this.requestsPerSecond = value; - return this; - } - - /** - * Required - API name: {@code retries} - */ - public final Builder retries(Retries value) { - this.retries = value; - return this; - } - - /** - * Required - API name: {@code retries} - */ - public final Builder retries(Function> fn) { - return this.retries(fn.apply(new Retries.Builder()).build()); - } - - /** - * API name: {@code throttled} - */ - public final Builder throttled(@Nullable Time value) { - this.throttled = value; - return this; - } - - /** - * API name: {@code throttled} - */ - public final Builder throttled(Function> fn) { - return this.throttled(fn.apply(new Time.Builder()).build()); - } - - /** - * Required - API name: {@code throttled_millis} - */ - public final Builder throttledMillis(long value) { - this.throttledMillis = value; - return this; - } - - /** - * API name: {@code throttled_until} - */ - public final Builder throttledUntil(@Nullable Time value) { - this.throttledUntil = value; - return this; - } - - /** - * API name: {@code throttled_until} - */ - public final Builder throttledUntil(Function> fn) { - return this.throttledUntil(fn.apply(new Time.Builder()).build()); - } - - /** - * Required - API name: {@code throttled_until_millis} - */ - public final Builder throttledUntilMillis(long value) { - this.throttledUntilMillis = value; - return this; - } - - /** - * API name: {@code timed_out} - */ - public final Builder timedOut(@Nullable Boolean value) { - this.timedOut = value; - return this; - } - - /** - * API name: {@code took} - */ - public final Builder took(@Nullable Long value) { - this.took = value; - return this; - } - - /** - * Required - API name: {@code total} - */ - public final Builder total(long value) { - this.total = value; - return this; - } - - /** - * Required - API name: {@code updated} - */ - public final Builder updated(long value) { - this.updated = value; - return this; - } - - /** - * Required - API name: {@code version_conflicts} - */ - public final Builder versionConflicts(long value) { - this.versionConflicts = value; - return this; - } - - @Override - protected Builder self() { - return this; - } - - /** - * Builds a {@link TaskStatus}. - * - * @throws NullPointerException - * if some of the required fields are null. - */ - public TaskStatus build() { - _checkSingleUse(); - - return new TaskStatus(this); - } - } - - // --------------------------------------------------------------------------------------------- - - /** - * Json deserializer for {@link TaskStatus} - */ - public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new, - TaskStatus::setupTaskStatusDeserializer); - - protected static void setupTaskStatusDeserializer(ObjectDeserializer op) { - - op.add(Builder::batches, JsonpDeserializer.longDeserializer(), "batches"); - op.add(Builder::canceled, JsonpDeserializer.stringDeserializer(), "canceled"); - op.add(Builder::created, JsonpDeserializer.longDeserializer(), "created"); - op.add(Builder::deleted, JsonpDeserializer.longDeserializer(), "deleted"); - op.add(Builder::noops, JsonpDeserializer.longDeserializer(), "noops"); - op.add(Builder::failures, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()), - "failures"); - op.add(Builder::requestsPerSecond, JsonpDeserializer.floatDeserializer(), "requests_per_second"); - op.add(Builder::retries, Retries._DESERIALIZER, "retries"); - op.add(Builder::throttled, Time._DESERIALIZER, "throttled"); - op.add(Builder::throttledMillis, JsonpDeserializer.longDeserializer(), "throttled_millis"); - op.add(Builder::throttledUntil, Time._DESERIALIZER, "throttled_until"); - op.add(Builder::throttledUntilMillis, JsonpDeserializer.longDeserializer(), "throttled_until_millis"); - op.add(Builder::timedOut, JsonpDeserializer.booleanDeserializer(), "timed_out"); - op.add(Builder::took, JsonpDeserializer.longDeserializer(), "took"); - op.add(Builder::total, JsonpDeserializer.longDeserializer(), "total"); - op.add(Builder::updated, JsonpDeserializer.longDeserializer(), "updated"); - op.add(Builder::versionConflicts, JsonpDeserializer.longDeserializer(), "version_conflicts"); - - } - -} diff --git a/java-client/src/test/java/co/elastic/clients/elasticsearch/model/UnionTests.java b/java-client/src/test/java/co/elastic/clients/elasticsearch/model/UnionTests.java index 004338899..d932793bb 100644 --- a/java-client/src/test/java/co/elastic/clients/elasticsearch/model/UnionTests.java +++ b/java-client/src/test/java/co/elastic/clients/elasticsearch/model/UnionTests.java @@ -23,8 +23,6 @@ import co.elastic.clients.elasticsearch._types.aggregations.Aggregate; import co.elastic.clients.elasticsearch._types.mapping.Property; import co.elastic.clients.elasticsearch._types.query_dsl.Query; -import co.elastic.clients.elasticsearch._types.query_dsl.SimpleQueryStringFlag; -import co.elastic.clients.elasticsearch._types.query_dsl.SimpleQueryStringFlags; import co.elastic.clients.elasticsearch.core.SearchResponse; import jakarta.json.Json; import jakarta.json.JsonObject; @@ -65,19 +63,6 @@ public void testScriptDeserializer() { } } - @Test - public void testSimpleQueryStringFlag() { - // Ambiguous union on strings - - SimpleQueryStringFlags f; - - f= fromJson("\"OR\"", SimpleQueryStringFlags.class); - assertEquals(SimpleQueryStringFlag.Or, f.single()); - - f = fromJson("\"OR|AND\"", SimpleQueryStringFlags.class); - assertEquals("OR|AND", f.multiple()); - } - @Test public void testOpenContainer() { String json = "{\"foo\":{\"bar\":42}}"; diff --git a/java-client/src/test/java/co/elastic/clients/json/jackson/JsonEnumTest.java b/java-client/src/test/java/co/elastic/clients/json/jackson/JsonEnumTest.java index dc6986cb7..16b922150 100644 --- a/java-client/src/test/java/co/elastic/clients/json/jackson/JsonEnumTest.java +++ b/java-client/src/test/java/co/elastic/clients/json/jackson/JsonEnumTest.java @@ -1,2 +1,56 @@ -package co.elastic.clients.json.jackson;public class JsonEnumTest { +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package co.elastic.clients.json.jackson; + +import co.elastic.clients.elasticsearch._types.query_dsl.SimpleQueryStringFlag; +import co.elastic.clients.elasticsearch._types.query_dsl.SimpleQueryStringQuery; +import co.elastic.clients.elasticsearch.model.ModelTestCase; +import org.junit.jupiter.api.Test; + +public class JsonEnumTest extends ModelTestCase { + + @Test + public void testPipeSeparatedEnum() { + { + // Empty flags + String jsonNoFlags = "{\"query\":\"foo\"}"; + SimpleQueryStringQuery q = SimpleQueryStringQuery.of(b -> b + .query("foo") + ); + q = checkJsonRoundtrip(q, jsonNoFlags); + assertEquals("foo", q.query()); + assertTrue(q.flags().isEmpty()); + } + + { + // With flags + String jsonWithFlags = "{\"flags\":\"AND|NEAR\",\"query\":\"foo\"}"; + SimpleQueryStringQuery q = SimpleQueryStringQuery.of(b -> b + .query("foo") + .flags(SimpleQueryStringFlag.And, SimpleQueryStringFlag.Near) + ); + q = checkJsonRoundtrip(q, jsonWithFlags); + assertEquals("foo", q.query()); + assertEquals(2, q.flags().size()); + assertEquals(SimpleQueryStringFlag.And, q.flags().get(0)); + assertEquals(SimpleQueryStringFlag.Near, q.flags().get(1)); + } + } }