From 625623f93228fee91a4578244a69c7dfb7a3e087 Mon Sep 17 00:00:00 2001 From: Nick Knize Date: Mon, 9 May 2022 13:20:19 -0500 Subject: [PATCH] [Javadocs] add to o.o.search.aggs, builder, and collapse packages (#3254) Adds class level javadocs to org.opensearch.search.aggregations, builder, and collapse packages. Signed-off-by: Nicholas Walter Knize --- .../search/aggregations/AbstractAggregationBuilder.java | 2 ++ .../org/opensearch/search/aggregations/Aggregation.java | 2 ++ .../opensearch/search/aggregations/AggregationBuilder.java | 2 ++ .../opensearch/search/aggregations/AggregationBuilders.java | 2 ++ .../search/aggregations/AggregationExecutionException.java | 2 ++ .../aggregations/AggregationInitializationException.java | 2 ++ .../opensearch/search/aggregations/AggregationPhase.java | 2 ++ .../org/opensearch/search/aggregations/Aggregations.java | 2 ++ .../java/org/opensearch/search/aggregations/Aggregator.java | 2 ++ .../org/opensearch/search/aggregations/AggregatorBase.java | 2 ++ .../opensearch/search/aggregations/AggregatorFactories.java | 2 ++ .../opensearch/search/aggregations/AggregatorFactory.java | 5 +++++ .../search/aggregations/BaseAggregationBuilder.java | 2 ++ .../org/opensearch/search/aggregations/BucketCollector.java | 2 ++ .../org/opensearch/search/aggregations/BucketOrder.java | 2 ++ .../search/aggregations/CardinalityUpperBound.java | 2 ++ .../org/opensearch/search/aggregations/HasAggregations.java | 5 +++++ .../opensearch/search/aggregations/InternalAggregation.java | 2 ++ .../search/aggregations/InternalAggregations.java | 2 ++ .../search/aggregations/InternalMultiBucketAggregation.java | 5 +++++ .../org/opensearch/search/aggregations/InternalOrder.java | 2 ++ .../aggregations/InvalidAggregationPathException.java | 5 +++++ .../org/opensearch/search/aggregations/KeyComparable.java | 2 ++ .../opensearch/search/aggregations/LeafBucketCollector.java | 2 ++ .../search/aggregations/LeafBucketCollectorBase.java | 2 ++ .../search/aggregations/MultiBucketCollector.java | 2 ++ .../search/aggregations/MultiBucketConsumerService.java | 2 ++ .../search/aggregations/NonCollectingAggregator.java | 2 ++ .../opensearch/search/aggregations/ParsedAggregation.java | 2 ++ .../search/aggregations/ParsedMultiBucketAggregation.java | 5 +++++ .../search/aggregations/PipelineAggregationBuilder.java | 2 ++ .../search/aggregations/PipelineAggregatorBuilders.java | 5 +++++ .../search/aggregations/SearchContextAggregations.java | 2 ++ .../aggregations/bucket/BestBucketsDeferringCollector.java | 2 ++ .../opensearch/search/aggregations/bucket/BucketUtils.java | 2 ++ .../search/aggregations/bucket/BucketsAggregator.java | 5 +++++ .../aggregations/bucket/DeferableBucketAggregator.java | 5 +++++ .../aggregations/bucket/DeferringBucketCollector.java | 2 ++ .../bucket/InternalSingleBucketAggregation.java | 2 ++ .../search/aggregations/bucket/IteratorAndCurrent.java | 5 +++++ .../bucket/MergingBucketsDeferringCollector.java | 2 ++ .../search/aggregations/bucket/MultiBucketsAggregation.java | 2 ++ .../aggregations/bucket/ParsedSingleBucketAggregation.java | 2 ++ .../search/aggregations/bucket/SingleBucketAggregation.java | 2 ++ .../search/aggregations/bucket/SingleBucketAggregator.java | 2 ++ .../aggregations/bucket/adjacency/AdjacencyMatrix.java | 2 ++ .../bucket/adjacency/AdjacencyMatrixAggregationBuilder.java | 5 +++++ .../bucket/adjacency/AdjacencyMatrixAggregator.java | 1 + .../bucket/adjacency/AdjacencyMatrixAggregatorFactory.java | 5 +++++ .../bucket/adjacency/InternalAdjacencyMatrix.java | 5 +++++ .../bucket/adjacency/ParsedAdjacencyMatrix.java | 5 +++++ .../aggregations/bucket/composite/BinaryValuesSource.java | 2 ++ .../aggregations/bucket/composite/CompositeAggregation.java | 5 +++++ .../bucket/composite/CompositeAggregationBuilder.java | 5 +++++ .../bucket/composite/CompositeAggregationFactory.java | 5 +++++ .../aggregations/bucket/composite/CompositeAggregator.java | 5 +++++ .../search/aggregations/bucket/composite/CompositeKey.java | 2 ++ .../bucket/composite/CompositeValuesCollectorQueue.java | 2 ++ .../bucket/composite/CompositeValuesSourceBuilder.java | 2 ++ .../bucket/composite/CompositeValuesSourceConfig.java | 5 +++++ .../bucket/composite/CompositeValuesSourceParserHelper.java | 5 +++++ .../bucket/composite/DateHistogramValuesSourceBuilder.java | 2 ++ .../aggregations/bucket/composite/DoubleValuesSource.java | 2 ++ .../bucket/composite/GeoTileGridValuesSourceBuilder.java | 5 +++++ .../aggregations/bucket/composite/GeoTileValuesSource.java | 2 ++ .../bucket/composite/GlobalOrdinalValuesSource.java | 2 ++ .../bucket/composite/HistogramValuesSource.java | 5 +++++ .../bucket/composite/HistogramValuesSourceBuilder.java | 2 ++ .../aggregations/bucket/composite/InternalComposite.java | 5 +++++ .../aggregations/bucket/composite/LongValuesSource.java | 2 ++ .../aggregations/bucket/composite/ParsedComposite.java | 5 +++++ .../bucket/composite/PointsSortedDocsProducer.java | 2 ++ .../aggregations/bucket/composite/RoundingValuesSource.java | 2 ++ .../bucket/composite/SingleDimensionValuesSource.java | 2 ++ .../aggregations/bucket/composite/SortedDocsProducer.java | 2 ++ .../bucket/composite/TermsSortedDocsProducer.java | 2 ++ .../bucket/composite/TermsValuesSourceBuilder.java | 2 ++ .../search/aggregations/bucket/filter/Filter.java | 2 ++ .../bucket/filter/FilterAggregationBuilder.java | 5 +++++ .../search/aggregations/bucket/filter/FilterAggregator.java | 2 ++ .../aggregations/bucket/filter/FilterAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/filter/Filters.java | 2 ++ .../bucket/filter/FiltersAggregationBuilder.java | 5 +++++ .../aggregations/bucket/filter/FiltersAggregator.java | 5 +++++ .../bucket/filter/FiltersAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/filter/InternalFilter.java | 5 +++++ .../search/aggregations/bucket/filter/InternalFilters.java | 5 +++++ .../search/aggregations/bucket/filter/ParsedFilter.java | 5 +++++ .../search/aggregations/bucket/filter/ParsedFilters.java | 5 +++++ .../aggregations/bucket/geogrid/BoundedCellValues.java | 2 ++ .../aggregations/bucket/geogrid/BucketPriorityQueue.java | 5 +++++ .../search/aggregations/bucket/geogrid/CellIdSource.java | 2 ++ .../search/aggregations/bucket/geogrid/CellValues.java | 2 ++ .../search/aggregations/bucket/geogrid/GeoGrid.java | 2 ++ .../bucket/geogrid/GeoGridAggregationBuilder.java | 5 +++++ .../aggregations/bucket/geogrid/GeoGridAggregator.java | 2 ++ .../bucket/geogrid/GeoHashGridAggregationBuilder.java | 5 +++++ .../aggregations/bucket/geogrid/GeoHashGridAggregator.java | 2 ++ .../bucket/geogrid/GeoHashGridAggregatorFactory.java | 5 +++++ .../bucket/geogrid/GeoTileGridAggregationBuilder.java | 5 +++++ .../aggregations/bucket/geogrid/GeoTileGridAggregator.java | 2 ++ .../bucket/geogrid/GeoTileGridAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/geogrid/GeoTileUtils.java | 2 ++ .../search/aggregations/bucket/geogrid/InternalGeoGrid.java | 2 ++ .../aggregations/bucket/geogrid/InternalGeoGridBucket.java | 5 +++++ .../aggregations/bucket/geogrid/InternalGeoHashGrid.java | 2 ++ .../bucket/geogrid/InternalGeoHashGridBucket.java | 5 +++++ .../aggregations/bucket/geogrid/InternalGeoTileGrid.java | 2 ++ .../bucket/geogrid/InternalGeoTileGridBucket.java | 5 +++++ .../search/aggregations/bucket/geogrid/ParsedGeoGrid.java | 5 +++++ .../aggregations/bucket/geogrid/ParsedGeoGridBucket.java | 5 +++++ .../aggregations/bucket/geogrid/ParsedGeoHashGrid.java | 5 +++++ .../bucket/geogrid/ParsedGeoHashGridBucket.java | 5 +++++ .../aggregations/bucket/geogrid/ParsedGeoTileGrid.java | 5 +++++ .../bucket/geogrid/ParsedGeoTileGridBucket.java | 5 +++++ .../aggregations/bucket/geogrid/UnboundedCellValues.java | 2 ++ .../search/aggregations/bucket/global/Global.java | 2 ++ .../bucket/global/GlobalAggregationBuilder.java | 5 +++++ .../search/aggregations/bucket/global/GlobalAggregator.java | 5 +++++ .../aggregations/bucket/global/GlobalAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/global/InternalGlobal.java | 2 ++ .../search/aggregations/bucket/global/ParsedGlobal.java | 5 +++++ .../bucket/histogram/AbstractHistogramAggregator.java | 2 ++ .../histogram/AutoDateHistogramAggregationBuilder.java | 5 +++++ .../bucket/histogram/AutoDateHistogramAggregator.java | 2 ++ .../histogram/AutoDateHistogramAggregatorFactory.java | 5 +++++ .../histogram/AutoDateHistogramAggregatorSupplier.java | 5 +++++ .../bucket/histogram/DateHistogramAggregationBuilder.java | 2 ++ .../bucket/histogram/DateHistogramAggregationSupplier.java | 5 +++++ .../bucket/histogram/DateHistogramAggregator.java | 2 ++ .../bucket/histogram/DateHistogramAggregatorFactory.java | 5 +++++ .../bucket/histogram/DateHistogramInterval.java | 2 ++ .../aggregations/bucket/histogram/DateIntervalConsumer.java | 2 ++ .../aggregations/bucket/histogram/DateIntervalWrapper.java | 2 ++ .../bucket/histogram/DateRangeHistogramAggregator.java | 2 ++ .../search/aggregations/bucket/histogram/DoubleBounds.java | 2 ++ .../search/aggregations/bucket/histogram/Histogram.java | 2 ++ .../bucket/histogram/HistogramAggregationBuilder.java | 2 ++ .../bucket/histogram/HistogramAggregatorFactory.java | 2 ++ .../bucket/histogram/HistogramAggregatorSupplier.java | 5 +++++ .../aggregations/bucket/histogram/HistogramFactory.java | 6 +++++- .../bucket/histogram/InternalAutoDateHistogram.java | 2 ++ .../bucket/histogram/InternalDateHistogram.java | 2 ++ .../aggregations/bucket/histogram/InternalHistogram.java | 2 ++ .../bucket/histogram/InternalVariableWidthHistogram.java | 5 +++++ .../search/aggregations/bucket/histogram/LongBounds.java | 2 ++ .../bucket/histogram/NumericHistogramAggregator.java | 2 ++ .../bucket/histogram/ParsedAutoDateHistogram.java | 5 +++++ .../aggregations/bucket/histogram/ParsedDateHistogram.java | 5 +++++ .../aggregations/bucket/histogram/ParsedHistogram.java | 5 +++++ .../bucket/histogram/ParsedVariableWidthHistogram.java | 5 +++++ .../bucket/histogram/RangeHistogramAggregator.java | 5 +++++ .../bucket/histogram/SizedBucketAggregator.java | 2 ++ .../bucket/histogram/SizedBucketAggregatorBuilder.java | 2 ++ .../histogram/VariableWidthHistogramAggregationBuilder.java | 5 +++++ .../bucket/histogram/VariableWidthHistogramAggregator.java | 5 +++++ .../histogram/VariableWidthHistogramAggregatorFactory.java | 5 +++++ .../histogram/VariableWidthHistogramAggregatorSupplier.java | 5 +++++ .../search/aggregations/bucket/missing/Missing.java | 2 ++ .../bucket/missing/MissingAggregationBuilder.java | 5 +++++ .../aggregations/bucket/missing/MissingAggregator.java | 5 +++++ .../bucket/missing/MissingAggregatorFactory.java | 5 +++++ .../bucket/missing/MissingAggregatorSupplier.java | 5 +++++ .../search/aggregations/bucket/missing/MissingOrder.java | 2 ++ .../search/aggregations/bucket/missing/ParsedMissing.java | 5 +++++ .../search/aggregations/bucket/nested/InternalNested.java | 2 ++ .../aggregations/bucket/nested/InternalReverseNested.java | 2 ++ .../search/aggregations/bucket/nested/Nested.java | 2 ++ .../bucket/nested/NestedAggregationBuilder.java | 5 +++++ .../search/aggregations/bucket/nested/NestedAggregator.java | 5 +++++ .../aggregations/bucket/nested/NestedAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/nested/ParsedNested.java | 5 +++++ .../aggregations/bucket/nested/ParsedReverseNested.java | 5 +++++ .../search/aggregations/bucket/nested/ReverseNested.java | 2 ++ .../bucket/nested/ReverseNestedAggregationBuilder.java | 5 +++++ .../aggregations/bucket/nested/ReverseNestedAggregator.java | 5 +++++ .../bucket/nested/ReverseNestedAggregatorFactory.java | 5 +++++ .../bucket/range/AbstractRangeAggregatorFactory.java | 5 +++++ .../aggregations/bucket/range/AbstractRangeBuilder.java | 5 +++++ .../aggregations/bucket/range/BinaryRangeAggregator.java | 6 +++++- .../bucket/range/BinaryRangeAggregatorFactory.java | 5 +++++ .../bucket/range/DateRangeAggregationBuilder.java | 5 +++++ .../bucket/range/DateRangeAggregatorFactory.java | 5 +++++ .../bucket/range/GeoDistanceAggregationBuilder.java | 5 +++++ .../bucket/range/GeoDistanceAggregatorSupplier.java | 5 +++++ .../bucket/range/GeoDistanceRangeAggregatorFactory.java | 5 +++++ .../aggregations/bucket/range/InternalBinaryRange.java | 6 +++++- .../search/aggregations/bucket/range/InternalDateRange.java | 5 +++++ .../aggregations/bucket/range/InternalGeoDistance.java | 5 +++++ .../search/aggregations/bucket/range/InternalRange.java | 5 +++++ .../bucket/range/IpRangeAggregationBuilder.java | 5 +++++ .../bucket/range/IpRangeAggregatorSupplier.java | 5 +++++ .../search/aggregations/bucket/range/ParsedBinaryRange.java | 5 +++++ .../search/aggregations/bucket/range/ParsedDateRange.java | 5 +++++ .../search/aggregations/bucket/range/ParsedGeoDistance.java | 5 +++++ .../search/aggregations/bucket/range/ParsedRange.java | 5 +++++ .../opensearch/search/aggregations/bucket/range/Range.java | 2 ++ .../aggregations/bucket/range/RangeAggregationBuilder.java | 5 +++++ .../search/aggregations/bucket/range/RangeAggregator.java | 5 +++++ .../aggregations/bucket/range/RangeAggregatorFactory.java | 5 +++++ .../aggregations/bucket/range/RangeAggregatorSupplier.java | 5 +++++ .../bucket/sampler/BestDocsDeferringCollector.java | 2 ++ .../bucket/sampler/DiversifiedAggregationBuilder.java | 5 +++++ .../bucket/sampler/DiversifiedAggregatorFactory.java | 5 +++++ .../bucket/sampler/DiversifiedAggregatorSupplier.java | 5 +++++ .../sampler/DiversifiedBytesHashSamplerAggregator.java | 2 ++ .../bucket/sampler/DiversifiedMapSamplerAggregator.java | 5 +++++ .../bucket/sampler/DiversifiedNumericSamplerAggregator.java | 5 +++++ .../sampler/DiversifiedOrdinalsSamplerAggregator.java | 5 +++++ .../search/aggregations/bucket/sampler/InternalSampler.java | 5 +++++ .../search/aggregations/bucket/sampler/ParsedSampler.java | 5 +++++ .../search/aggregations/bucket/sampler/Sampler.java | 2 ++ .../bucket/sampler/SamplerAggregationBuilder.java | 5 +++++ .../aggregations/bucket/sampler/SamplerAggregator.java | 2 ++ .../bucket/sampler/SamplerAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/sampler/UnmappedSampler.java | 5 +++++ .../bucket/terms/AbstractRareTermsAggregator.java | 5 +++++ .../bucket/terms/AbstractStringTermsAggregator.java | 5 +++++ .../aggregations/bucket/terms/BucketPriorityQueue.java | 5 +++++ .../bucket/terms/BucketSignificancePriorityQueue.java | 5 +++++ .../aggregations/bucket/terms/BytesKeyedBucketOrds.java | 2 ++ .../search/aggregations/bucket/terms/DoubleTerms.java | 2 ++ .../bucket/terms/GlobalOrdinalsStringTermsAggregator.java | 2 ++ .../search/aggregations/bucket/terms/IncludeExclude.java | 2 ++ .../aggregations/bucket/terms/InternalMappedRareTerms.java | 5 +++++ .../bucket/terms/InternalMappedSignificantTerms.java | 5 +++++ .../aggregations/bucket/terms/InternalMappedTerms.java | 2 ++ .../aggregations/bucket/terms/InternalMultiTerms.java | 2 ++ .../search/aggregations/bucket/terms/InternalRareTerms.java | 5 +++++ .../aggregations/bucket/terms/InternalSignificantTerms.java | 2 ++ .../search/aggregations/bucket/terms/InternalTerms.java | 5 +++++ .../aggregations/bucket/terms/LongKeyedBucketOrds.java | 2 ++ .../search/aggregations/bucket/terms/LongRareTerms.java | 2 ++ .../aggregations/bucket/terms/LongRareTermsAggregator.java | 2 ++ .../search/aggregations/bucket/terms/LongTerms.java | 2 ++ .../aggregations/bucket/terms/MapStringTermsAggregator.java | 2 ++ .../bucket/terms/MultiTermsAggregationBuilder.java | 2 ++ .../bucket/terms/MultiTermsAggregationFactory.java | 2 ++ .../aggregations/bucket/terms/MultiTermsAggregator.java | 2 ++ .../aggregations/bucket/terms/NumericTermsAggregator.java | 5 +++++ .../search/aggregations/bucket/terms/ParsedDoubleTerms.java | 5 +++++ .../aggregations/bucket/terms/ParsedLongRareTerms.java | 5 +++++ .../search/aggregations/bucket/terms/ParsedLongTerms.java | 5 +++++ .../search/aggregations/bucket/terms/ParsedMultiTerms.java | 5 +++++ .../search/aggregations/bucket/terms/ParsedRareTerms.java | 5 +++++ .../bucket/terms/ParsedSignificantLongTerms.java | 5 +++++ .../bucket/terms/ParsedSignificantStringTerms.java | 5 +++++ .../aggregations/bucket/terms/ParsedSignificantTerms.java | 5 +++++ .../aggregations/bucket/terms/ParsedStringRareTerms.java | 5 +++++ .../search/aggregations/bucket/terms/ParsedStringTerms.java | 5 +++++ .../search/aggregations/bucket/terms/ParsedTerms.java | 5 +++++ .../search/aggregations/bucket/terms/RareTerms.java | 5 +++++ .../bucket/terms/RareTermsAggregationBuilder.java | 5 +++++ .../bucket/terms/RareTermsAggregatorFactory.java | 5 +++++ .../bucket/terms/RareTermsAggregatorSupplier.java | 5 +++++ .../aggregations/bucket/terms/SignificanceLookup.java | 2 ++ .../aggregations/bucket/terms/SignificantLongTerms.java | 2 ++ .../aggregations/bucket/terms/SignificantStringTerms.java | 2 ++ .../search/aggregations/bucket/terms/SignificantTerms.java | 2 ++ .../bucket/terms/SignificantTermsAggregationBuilder.java | 5 +++++ .../bucket/terms/SignificantTermsAggregatorFactory.java | 5 +++++ .../bucket/terms/SignificantTermsAggregatorSupplier.java | 5 +++++ .../bucket/terms/SignificantTextAggregationBuilder.java | 5 +++++ .../bucket/terms/SignificantTextAggregatorFactory.java | 5 +++++ .../search/aggregations/bucket/terms/StringRareTerms.java | 5 +++++ .../bucket/terms/StringRareTermsAggregator.java | 2 ++ .../search/aggregations/bucket/terms/StringTerms.java | 2 ++ .../opensearch/search/aggregations/bucket/terms/Terms.java | 2 ++ .../aggregations/bucket/terms/TermsAggregationBuilder.java | 5 +++++ .../search/aggregations/bucket/terms/TermsAggregator.java | 5 +++++ .../aggregations/bucket/terms/TermsAggregatorFactory.java | 5 +++++ .../aggregations/bucket/terms/TermsAggregatorSupplier.java | 5 +++++ .../search/aggregations/bucket/terms/UnmappedRareTerms.java | 2 ++ .../aggregations/bucket/terms/UnmappedSignificantTerms.java | 2 ++ .../search/aggregations/bucket/terms/UnmappedTerms.java | 2 ++ .../aggregations/bucket/terms/heuristic/ChiSquare.java | 5 +++++ .../search/aggregations/bucket/terms/heuristic/GND.java | 5 +++++ .../aggregations/bucket/terms/heuristic/JLHScore.java | 5 +++++ .../bucket/terms/heuristic/MutualInformation.java | 5 +++++ .../bucket/terms/heuristic/NXYSignificanceHeuristic.java | 5 +++++ .../bucket/terms/heuristic/PercentageScore.java | 5 +++++ .../bucket/terms/heuristic/ScriptHeuristic.java | 5 +++++ .../bucket/terms/heuristic/SignificanceHeuristic.java | 2 ++ .../terms/heuristic/SignificanceHeuristicBuilder.java | 5 +++++ .../aggregations/metrics/AbstractCardinalityAlgorithm.java | 2 ++ .../metrics/AbstractHDRPercentilesAggregator.java | 5 +++++ .../search/aggregations/metrics/AbstractHyperLogLog.java | 2 ++ .../aggregations/metrics/AbstractHyperLogLogPlusPlus.java | 2 ++ .../metrics/AbstractInternalHDRPercentiles.java | 5 +++++ .../metrics/AbstractInternalTDigestPercentiles.java | 5 +++++ .../search/aggregations/metrics/AbstractLinearCounting.java | 2 ++ .../metrics/AbstractPercentilesAggregationBuilder.java | 2 ++ .../metrics/AbstractTDigestPercentilesAggregator.java | 5 +++++ .../org/opensearch/search/aggregations/metrics/Avg.java | 2 ++ .../search/aggregations/metrics/AvgAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/AvgAggregator.java | 5 +++++ .../search/aggregations/metrics/AvgAggregatorFactory.java | 5 +++++ .../opensearch/search/aggregations/metrics/Cardinality.java | 2 ++ .../aggregations/metrics/CardinalityAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/CardinalityAggregator.java | 2 ++ .../aggregations/metrics/CardinalityAggregatorFactory.java | 5 +++++ .../aggregations/metrics/CardinalityAggregatorSupplier.java | 5 +++++ .../search/aggregations/metrics/CompensatedSum.java | 2 ++ .../search/aggregations/metrics/ExtendedStats.java | 2 ++ .../metrics/ExtendedStatsAggregationBuilder.java | 5 +++++ .../aggregations/metrics/ExtendedStatsAggregator.java | 5 +++++ .../metrics/ExtendedStatsAggregatorFactory.java | 5 +++++ .../metrics/ExtendedStatsAggregatorProvider.java | 3 +++ .../opensearch/search/aggregations/metrics/GeoBounds.java | 2 ++ .../aggregations/metrics/GeoBoundsAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/GeoBoundsAggregator.java | 5 +++++ .../aggregations/metrics/GeoBoundsAggregatorFactory.java | 5 +++++ .../aggregations/metrics/GeoBoundsAggregatorSupplier.java | 5 +++++ .../opensearch/search/aggregations/metrics/GeoCentroid.java | 2 ++ .../aggregations/metrics/GeoCentroidAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/GeoCentroidAggregator.java | 2 ++ .../aggregations/metrics/GeoCentroidAggregatorFactory.java | 5 +++++ .../aggregations/metrics/GeoGridAggregatorSupplier.java | 5 +++++ .../aggregations/metrics/HDRPercentileRanksAggregator.java | 5 +++++ .../aggregations/metrics/HDRPercentilesAggregator.java | 5 +++++ .../search/aggregations/metrics/HyperLogLogPlusPlus.java | 2 ++ .../aggregations/metrics/HyperLogLogPlusPlusSparse.java | 2 ++ .../opensearch/search/aggregations/metrics/InternalAvg.java | 5 +++++ .../search/aggregations/metrics/InternalCardinality.java | 5 +++++ .../search/aggregations/metrics/InternalExtendedStats.java | 5 +++++ .../search/aggregations/metrics/InternalGeoBounds.java | 5 +++++ .../search/aggregations/metrics/InternalGeoCentroid.java | 2 ++ .../aggregations/metrics/InternalHDRPercentileRanks.java | 5 +++++ .../search/aggregations/metrics/InternalHDRPercentiles.java | 5 +++++ .../opensearch/search/aggregations/metrics/InternalMax.java | 5 +++++ .../metrics/InternalMedianAbsoluteDeviation.java | 5 +++++ .../opensearch/search/aggregations/metrics/InternalMin.java | 5 +++++ .../metrics/InternalNumericMetricsAggregation.java | 5 +++++ .../search/aggregations/metrics/InternalScriptedMetric.java | 5 +++++ .../search/aggregations/metrics/InternalStats.java | 5 +++++ .../opensearch/search/aggregations/metrics/InternalSum.java | 5 +++++ .../metrics/InternalTDigestPercentileRanks.java | 5 +++++ .../aggregations/metrics/InternalTDigestPercentiles.java | 5 +++++ .../search/aggregations/metrics/InternalTopHits.java | 2 ++ .../search/aggregations/metrics/InternalValueCount.java | 2 ++ .../search/aggregations/metrics/InternalWeightedAvg.java | 5 +++++ .../org/opensearch/search/aggregations/metrics/Max.java | 2 ++ .../search/aggregations/metrics/MaxAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/MaxAggregator.java | 5 +++++ .../search/aggregations/metrics/MaxAggregatorFactory.java | 5 +++++ .../aggregations/metrics/MedianAbsoluteDeviation.java | 2 ++ .../metrics/MedianAbsoluteDeviationAggregationBuilder.java | 5 +++++ .../metrics/MedianAbsoluteDeviationAggregator.java | 5 +++++ .../metrics/MedianAbsoluteDeviationAggregatorFactory.java | 5 +++++ .../metrics/MedianAbsoluteDeviationAggregatorSupplier.java | 5 +++++ .../aggregations/metrics/MetricAggregatorSupplier.java | 5 +++++ .../search/aggregations/metrics/MetricInspectionHelper.java | 2 ++ .../search/aggregations/metrics/MetricsAggregator.java | 5 +++++ .../org/opensearch/search/aggregations/metrics/Min.java | 2 ++ .../search/aggregations/metrics/MinAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/MinAggregator.java | 5 +++++ .../search/aggregations/metrics/MinAggregatorFactory.java | 5 +++++ .../aggregations/metrics/NumericMetricsAggregation.java | 5 +++++ .../aggregations/metrics/NumericMetricsAggregator.java | 5 +++++ .../opensearch/search/aggregations/metrics/ParsedAvg.java | 5 +++++ .../search/aggregations/metrics/ParsedCardinality.java | 5 +++++ .../search/aggregations/metrics/ParsedExtendedStats.java | 5 +++++ .../search/aggregations/metrics/ParsedGeoBounds.java | 5 +++++ .../search/aggregations/metrics/ParsedGeoCentroid.java | 2 ++ .../aggregations/metrics/ParsedHDRPercentileRanks.java | 5 +++++ .../search/aggregations/metrics/ParsedHDRPercentiles.java | 5 +++++ .../opensearch/search/aggregations/metrics/ParsedMax.java | 5 +++++ .../aggregations/metrics/ParsedMedianAbsoluteDeviation.java | 5 +++++ .../opensearch/search/aggregations/metrics/ParsedMin.java | 5 +++++ .../search/aggregations/metrics/ParsedPercentileRanks.java | 5 +++++ .../search/aggregations/metrics/ParsedPercentiles.java | 5 +++++ .../search/aggregations/metrics/ParsedScriptedMetric.java | 5 +++++ .../metrics/ParsedSingleValueNumericMetricsAggregation.java | 5 +++++ .../opensearch/search/aggregations/metrics/ParsedStats.java | 5 +++++ .../opensearch/search/aggregations/metrics/ParsedSum.java | 5 +++++ .../aggregations/metrics/ParsedTDigestPercentileRanks.java | 5 +++++ .../aggregations/metrics/ParsedTDigestPercentiles.java | 5 +++++ .../search/aggregations/metrics/ParsedTopHits.java | 5 +++++ .../search/aggregations/metrics/ParsedValueCount.java | 5 +++++ .../search/aggregations/metrics/ParsedWeightedAvg.java | 5 +++++ .../opensearch/search/aggregations/metrics/Percentile.java | 5 +++++ .../search/aggregations/metrics/PercentileRanks.java | 2 ++ .../metrics/PercentileRanksAggregationBuilder.java | 5 +++++ .../metrics/PercentileRanksAggregatorFactory.java | 5 +++++ .../opensearch/search/aggregations/metrics/Percentiles.java | 2 ++ .../aggregations/metrics/PercentilesAggregationBuilder.java | 5 +++++ .../aggregations/metrics/PercentilesAggregatorFactory.java | 2 ++ .../aggregations/metrics/PercentilesAggregatorSupplier.java | 5 +++++ .../search/aggregations/metrics/PercentilesConfig.java | 2 ++ .../search/aggregations/metrics/PercentilesMethod.java | 2 ++ .../search/aggregations/metrics/ScriptedMetric.java | 2 ++ .../metrics/ScriptedMetricAggregationBuilder.java | 5 +++++ .../aggregations/metrics/ScriptedMetricAggregator.java | 5 +++++ .../metrics/ScriptedMetricAggregatorFactory.java | 5 +++++ .../org/opensearch/search/aggregations/metrics/Stats.java | 2 ++ .../aggregations/metrics/StatsAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/StatsAggregator.java | 5 +++++ .../search/aggregations/metrics/StatsAggregatorFactory.java | 5 +++++ .../org/opensearch/search/aggregations/metrics/Sum.java | 2 ++ .../search/aggregations/metrics/SumAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/SumAggregator.java | 5 +++++ .../search/aggregations/metrics/SumAggregatorFactory.java | 5 +++++ .../metrics/TDigestPercentileRanksAggregator.java | 5 +++++ .../aggregations/metrics/TDigestPercentilesAggregator.java | 5 +++++ .../search/aggregations/metrics/TDigestState.java | 2 ++ .../org/opensearch/search/aggregations/metrics/TopHits.java | 2 ++ .../aggregations/metrics/TopHitsAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/TopHitsAggregator.java | 5 +++++ .../aggregations/metrics/TopHitsAggregatorFactory.java | 5 +++++ .../opensearch/search/aggregations/metrics/ValueCount.java | 2 ++ .../aggregations/metrics/ValueCountAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/ValueCountAggregator.java | 2 ++ .../aggregations/metrics/ValueCountAggregatorFactory.java | 5 +++++ .../opensearch/search/aggregations/metrics/WeightedAvg.java | 2 ++ .../aggregations/metrics/WeightedAvgAggregationBuilder.java | 5 +++++ .../search/aggregations/metrics/WeightedAvgAggregator.java | 5 +++++ .../aggregations/metrics/WeightedAvgAggregatorFactory.java | 5 +++++ .../pipeline/AbstractPipelineAggregationBuilder.java | 2 ++ .../pipeline/AvgBucketPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/AvgBucketPipelineAggregator.java | 5 +++++ .../search/aggregations/pipeline/BucketHelpers.java | 2 ++ .../search/aggregations/pipeline/BucketMetricValue.java | 5 +++++ .../search/aggregations/pipeline/BucketMetricsParser.java | 2 ++ .../pipeline/BucketMetricsPipelineAggregationBuilder.java | 5 +++++ .../pipeline/BucketMetricsPipelineAggregator.java | 2 ++ .../pipeline/BucketScriptPipelineAggregationBuilder.java | 5 +++++ .../pipeline/BucketScriptPipelineAggregator.java | 5 +++++ .../pipeline/BucketSelectorPipelineAggregationBuilder.java | 5 +++++ .../pipeline/BucketSelectorPipelineAggregator.java | 5 +++++ .../pipeline/BucketSortPipelineAggregationBuilder.java | 2 ++ .../aggregations/pipeline/BucketSortPipelineAggregator.java | 5 +++++ .../pipeline/CumulativeSumPipelineAggregationBuilder.java | 5 +++++ .../pipeline/CumulativeSumPipelineAggregator.java | 5 +++++ .../opensearch/search/aggregations/pipeline/Derivative.java | 5 +++++ .../pipeline/DerivativePipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/DerivativePipelineAggregator.java | 5 +++++ .../opensearch/search/aggregations/pipeline/EwmaModel.java | 2 ++ .../search/aggregations/pipeline/ExtendedStatsBucket.java | 2 ++ .../aggregations/pipeline/ExtendedStatsBucketParser.java | 5 +++++ .../ExtendedStatsBucketPipelineAggregationBuilder.java | 5 +++++ .../pipeline/ExtendedStatsBucketPipelineAggregator.java | 5 +++++ .../search/aggregations/pipeline/HoltLinearModel.java | 2 ++ .../search/aggregations/pipeline/HoltWintersModel.java | 2 ++ .../aggregations/pipeline/InternalBucketMetricValue.java | 5 +++++ .../search/aggregations/pipeline/InternalDerivative.java | 5 +++++ .../aggregations/pipeline/InternalExtendedStatsBucket.java | 5 +++++ .../aggregations/pipeline/InternalPercentilesBucket.java | 5 +++++ .../search/aggregations/pipeline/InternalSimpleValue.java | 5 +++++ .../search/aggregations/pipeline/InternalStatsBucket.java | 5 +++++ .../search/aggregations/pipeline/LinearModel.java | 2 ++ .../pipeline/MaxBucketPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/MaxBucketPipelineAggregator.java | 5 +++++ .../pipeline/MinBucketPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/MinBucketPipelineAggregator.java | 5 +++++ .../search/aggregations/pipeline/MovAvgModel.java | 5 +++++ .../search/aggregations/pipeline/MovAvgModelBuilder.java | 2 ++ .../pipeline/MovAvgPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/MovAvgPipelineAggregator.java | 5 +++++ .../pipeline/MovFnPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/MovFnPipelineAggregator.java | 2 ++ .../search/aggregations/pipeline/MovingFunctionScript.java | 2 ++ .../search/aggregations/pipeline/MovingFunctions.java | 2 ++ .../aggregations/pipeline/ParsedBucketMetricValue.java | 5 +++++ .../search/aggregations/pipeline/ParsedDerivative.java | 5 +++++ .../aggregations/pipeline/ParsedExtendedStatsBucket.java | 5 +++++ .../aggregations/pipeline/ParsedPercentilesBucket.java | 5 +++++ .../search/aggregations/pipeline/ParsedSimpleValue.java | 5 +++++ .../search/aggregations/pipeline/ParsedStatsBucket.java | 5 +++++ .../search/aggregations/pipeline/PercentilesBucket.java | 5 +++++ .../PercentilesBucketPipelineAggregationBuilder.java | 5 +++++ .../pipeline/PercentilesBucketPipelineAggregator.java | 5 +++++ .../search/aggregations/pipeline/PipelineAggregator.java | 5 +++++ .../pipeline/SerialDiffPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/SerialDiffPipelineAggregator.java | 5 +++++ .../aggregations/pipeline/SiblingPipelineAggregator.java | 5 +++++ .../search/aggregations/pipeline/SimpleModel.java | 2 ++ .../search/aggregations/pipeline/SimpleValue.java | 5 +++++ .../aggregations/pipeline/SimulatedAnealingMinimizer.java | 2 ++ .../search/aggregations/pipeline/StatsBucket.java | 2 ++ .../pipeline/StatsBucketPipelineAggregationBuilder.java | 5 +++++ .../pipeline/StatsBucketPipelineAggregator.java | 5 +++++ .../pipeline/SumBucketPipelineAggregationBuilder.java | 5 +++++ .../aggregations/pipeline/SumBucketPipelineAggregator.java | 5 +++++ .../search/aggregations/support/AggregationInfo.java | 5 +++++ .../aggregations/support/AggregationInspectionHelper.java | 2 ++ .../search/aggregations/support/AggregationPath.java | 2 ++ .../aggregations/support/AggregationUsageService.java | 5 +++++ .../support/BaseMultiValuesSourceFieldConfig.java | 2 ++ .../search/aggregations/support/CoreValuesSourceType.java | 2 ++ .../search/aggregations/support/FieldContext.java | 2 ++ .../search/aggregations/support/MissingValues.java | 2 ++ .../aggregations/support/MultiTermsValuesSourceConfig.java | 2 ++ .../search/aggregations/support/MultiValuesSource.java | 2 ++ .../support/MultiValuesSourceAggregationBuilder.java | 2 ++ .../support/MultiValuesSourceAggregatorFactory.java | 5 +++++ .../aggregations/support/MultiValuesSourceFieldConfig.java | 5 +++++ .../aggregations/support/MultiValuesSourceParseHelper.java | 5 +++++ .../opensearch/search/aggregations/support/ValueType.java | 5 +++++ .../search/aggregations/support/ValuesSource.java | 5 +++++ .../support/ValuesSourceAggregationBuilder.java | 5 +++++ .../aggregations/support/ValuesSourceAggregatorFactory.java | 5 +++++ .../search/aggregations/support/ValuesSourceConfig.java | 2 ++ .../search/aggregations/support/ValuesSourceRegistry.java | 1 + .../search/aggregations/support/ValuesSourceType.java | 2 ++ .../aggregations/support/values/ScriptBytesValues.java | 2 ++ .../aggregations/support/values/ScriptDoubleValues.java | 2 ++ .../aggregations/support/values/ScriptLongValues.java | 2 ++ .../org/opensearch/search/builder/PointInTimeBuilder.java | 2 ++ .../org/opensearch/search/builder/SearchSourceBuilder.java | 2 ++ .../search/builder/SearchSourceBuilderException.java | 5 +++++ .../org/opensearch/search/collapse/CollapseBuilder.java | 2 ++ .../org/opensearch/search/collapse/CollapseContext.java | 2 ++ 512 files changed, 1959 insertions(+), 3 deletions(-) diff --git a/server/src/main/java/org/opensearch/search/aggregations/AbstractAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/AbstractAggregationBuilder.java index 8b5bbc9f28d..5863bf66f59 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AbstractAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AbstractAggregationBuilder.java @@ -43,6 +43,8 @@ import java.util.Objects; /** * Base implementation of a {@link AggregationBuilder}. + * + * @opensearch.internal */ public abstract class AbstractAggregationBuilder> extends AggregationBuilder { diff --git a/server/src/main/java/org/opensearch/search/aggregations/Aggregation.java b/server/src/main/java/org/opensearch/search/aggregations/Aggregation.java index 6c4a4ce8dd6..66c3ec04771 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/Aggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/Aggregation.java @@ -39,6 +39,8 @@ import java.util.Map; /** * An aggregation. Extends {@link ToXContent} as it makes it easier to print out its content. + * + * @opensearch.internal */ public interface Aggregation extends ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilder.java index 1e372aff17c..5c76f0cc091 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilder.java @@ -48,6 +48,8 @@ import java.util.Map; /** * A factory that knows how to create an {@link Aggregator} of a specific type. + * + * @opensearch.internal */ public abstract class AggregationBuilder implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilders.java b/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilders.java index 69a9fd92ac4..01e0f95b0d7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilders.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilders.java @@ -109,6 +109,8 @@ import java.util.Map; /** * Utility class to create aggregations. + * + * @opensearch.internal */ public class AggregationBuilders { diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregationExecutionException.java b/server/src/main/java/org/opensearch/search/aggregations/AggregationExecutionException.java index 5bb65bc33fc..989783b11da 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationExecutionException.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationExecutionException.java @@ -38,6 +38,8 @@ import java.io.IOException; /** * Thrown when failing to execute an aggregation + * + * @opensearch.internal */ public class AggregationExecutionException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregationInitializationException.java b/server/src/main/java/org/opensearch/search/aggregations/AggregationInitializationException.java index c73cd7670b3..87fcfece070 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationInitializationException.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationInitializationException.java @@ -38,6 +38,8 @@ import java.io.IOException; /** * Thrown when failing to execute an aggregation + * + * @opensearch.internal */ public class AggregationInitializationException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregationPhase.java b/server/src/main/java/org/opensearch/search/aggregations/AggregationPhase.java index 5a837a6e14c..c091a1bc47c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationPhase.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationPhase.java @@ -51,6 +51,8 @@ import java.util.List; /** * Aggregation phase of a search request, used to collect aggregations + * + * @opensearch.internal */ public class AggregationPhase { diff --git a/server/src/main/java/org/opensearch/search/aggregations/Aggregations.java b/server/src/main/java/org/opensearch/search/aggregations/Aggregations.java index 9360f03304c..4049d96d688 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/Aggregations.java +++ b/server/src/main/java/org/opensearch/search/aggregations/Aggregations.java @@ -53,6 +53,8 @@ import static org.opensearch.common.xcontent.XContentParserUtils.parseTypedKeysO /** * Represents a set of {@link Aggregation}s + * + * @opensearch.internal */ public class Aggregations implements Iterable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/Aggregator.java b/server/src/main/java/org/opensearch/search/aggregations/Aggregator.java index b38dfe123fd..99a54bbdc27 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/Aggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/Aggregator.java @@ -54,6 +54,8 @@ import java.util.function.BiConsumer; *

* Be careful when adding methods to this class. If possible * make sure they have sensible default implementations. + * + * @opensearch.internal */ public abstract class Aggregator extends BucketCollector implements Releasable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregatorBase.java b/server/src/main/java/org/opensearch/search/aggregations/AggregatorBase.java index 09af84bc811..db51f00056f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregatorBase.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregatorBase.java @@ -52,6 +52,8 @@ import java.util.function.Function; /** * Base implementation for concrete aggregators. + * + * @opensearch.internal */ public abstract class AggregatorBase extends Aggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactories.java b/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactories.java index 1dde4c782c9..ec536578f72 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactories.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactories.java @@ -77,6 +77,8 @@ import static java.util.stream.Collectors.toMap; /** * An immutable collection of {@link AggregatorFactories}. + * + * @opensearch.internal */ public class AggregatorFactories { public static final Pattern VALID_AGG_NAME = Pattern.compile("[^\\[\\]>]+"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactory.java index 65f44c8a346..05686f35c21 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactory.java @@ -40,6 +40,11 @@ import java.util.Map; import static org.opensearch.search.aggregations.support.AggregationUsageService.OTHER_SUBTYPE; +/** + * Base factory to instantiate an internal aggregator + * + * @opensearch.internal + */ public abstract class AggregatorFactory { protected final String name; protected final AggregatorFactory parent; diff --git a/server/src/main/java/org/opensearch/search/aggregations/BaseAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/BaseAggregationBuilder.java index 24b34c2c111..2232367b16c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/BaseAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/BaseAggregationBuilder.java @@ -40,6 +40,8 @@ import java.util.Map; /** * Interface shared by {@link AggregationBuilder} and {@link PipelineAggregationBuilder} so they can conveniently share the same namespace * for {@link XContentParser#namedObject(Class, String, Object)}. + * + * @opensearch.internal */ public interface BaseAggregationBuilder { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/BucketCollector.java b/server/src/main/java/org/opensearch/search/aggregations/BucketCollector.java index e84f4d19e80..5db683252a0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/BucketCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/BucketCollector.java @@ -40,6 +40,8 @@ import java.io.IOException; /** * A Collector that can collect data in separate buckets. + * + * @opensearch.internal */ public abstract class BucketCollector implements Collector { diff --git a/server/src/main/java/org/opensearch/search/aggregations/BucketOrder.java b/server/src/main/java/org/opensearch/search/aggregations/BucketOrder.java index 423c143e6aa..6dc8c9a61d8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/BucketOrder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/BucketOrder.java @@ -49,6 +49,8 @@ import java.util.function.ToLongFunction; * "complete" buckets using {@link #comparator()} or against a combination * of the buckets internals with its ordinal with * {@link #partiallyBuiltBucketComparator(ToLongFunction, Aggregator)}. + * + * @opensearch.internal */ public abstract class BucketOrder implements ToXContentObject, Writeable { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/CardinalityUpperBound.java b/server/src/main/java/org/opensearch/search/aggregations/CardinalityUpperBound.java index 984c8a08729..7596cf471c4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/CardinalityUpperBound.java +++ b/server/src/main/java/org/opensearch/search/aggregations/CardinalityUpperBound.java @@ -41,6 +41,8 @@ import java.util.function.IntFunction; /** * Upper bound of how many {@code owningBucketOrds} that an {@link Aggregator} * will have to collect into. + * + * @opensearch.internal */ public abstract class CardinalityUpperBound { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/HasAggregations.java b/server/src/main/java/org/opensearch/search/aggregations/HasAggregations.java index 92b4d3f69bb..6d3c599eee0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/HasAggregations.java +++ b/server/src/main/java/org/opensearch/search/aggregations/HasAggregations.java @@ -32,6 +32,11 @@ package org.opensearch.search.aggregations; +/** + * Base interface for buckets that have sub aggs + * + * @opensearch.internal + */ public interface HasAggregations { Aggregations getAggregations(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/InternalAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/InternalAggregation.java index 7c403bcb9db..55c400218b0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalAggregation.java @@ -58,6 +58,8 @@ import static java.util.Objects.requireNonNull; /** * An internal implementation of {@link Aggregation}. Serves as a base class for all aggregation implementations. + * + * @opensearch.internal */ public abstract class InternalAggregation implements Aggregation, NamedWriteable { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/InternalAggregations.java b/server/src/main/java/org/opensearch/search/aggregations/InternalAggregations.java index 371a2b04ae0..fb8fb18598d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalAggregations.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalAggregations.java @@ -59,6 +59,8 @@ import static java.util.stream.Collectors.toList; /** * An internal implementation of {@link Aggregations}. + * + * @opensearch.internal */ public final class InternalAggregations extends Aggregations implements Writeable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/InternalMultiBucketAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/InternalMultiBucketAggregation.java index 983f2cbe21a..b519334e6f9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalMultiBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalMultiBucketAggregation.java @@ -45,6 +45,11 @@ import java.util.Map; import java.util.function.Consumer; import java.util.function.Function; +/** + * Base class for internal aggregations that are comprised of multiple buckets + * + * @opensearch.internal + */ public abstract class InternalMultiBucketAggregation< A extends InternalMultiBucketAggregation, B extends InternalMultiBucketAggregation.InternalBucket> extends InternalAggregation implements MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/InternalOrder.java b/server/src/main/java/org/opensearch/search/aggregations/InternalOrder.java index 923650fbeac..491e08bc847 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalOrder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalOrder.java @@ -58,6 +58,8 @@ import static java.util.stream.Collectors.toList; /** * Implementations for {@link Bucket} ordering strategies. + * + * @opensearch.internal */ public abstract class InternalOrder extends BucketOrder { // TODO merge the contents of this file into BucketOrder. The way it is now is relic. diff --git a/server/src/main/java/org/opensearch/search/aggregations/InvalidAggregationPathException.java b/server/src/main/java/org/opensearch/search/aggregations/InvalidAggregationPathException.java index 011206ddd04..1222e3904ea 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InvalidAggregationPathException.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InvalidAggregationPathException.java @@ -37,6 +37,11 @@ import org.opensearch.common.io.stream.StreamInput; import java.io.IOException; +/** + * Error thrown when an invalid agg is called + * + * @opensearch.internal + */ public class InvalidAggregationPathException extends OpenSearchException { public InvalidAggregationPathException(String msg) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/KeyComparable.java b/server/src/main/java/org/opensearch/search/aggregations/KeyComparable.java index 1e64ad8992a..5acf32183a8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/KeyComparable.java +++ b/server/src/main/java/org/opensearch/search/aggregations/KeyComparable.java @@ -39,6 +39,8 @@ import org.opensearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket; * * @param {@link Bucket} of the same type that also implements {@link KeyComparable}. * @see BucketOrder#key(boolean) + * + * @opensearch.internal */ public interface KeyComparable> { diff --git a/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollector.java b/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollector.java index 0d29469f12d..6694ba3e0a3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollector.java @@ -42,6 +42,8 @@ import java.util.stream.StreamSupport; /** * Per-leaf bucket collector. + * + * @opensearch.internal */ public abstract class LeafBucketCollector implements LeafCollector { diff --git a/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollectorBase.java b/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollectorBase.java index 2da9f4307c4..5b5f2b7a6f8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollectorBase.java +++ b/server/src/main/java/org/opensearch/search/aggregations/LeafBucketCollectorBase.java @@ -41,6 +41,8 @@ import java.io.IOException; * A {@link LeafBucketCollector} that delegates all calls to the sub leaf * aggregator and sets the scorer on its source of values if it implements * {@link ScorerAware}. + * + * @opensearch.internal */ public class LeafBucketCollectorBase extends LeafBucketCollector { diff --git a/server/src/main/java/org/opensearch/search/aggregations/MultiBucketCollector.java b/server/src/main/java/org/opensearch/search/aggregations/MultiBucketCollector.java index 6bb044b1d7e..80c7b37624f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/MultiBucketCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/MultiBucketCollector.java @@ -51,6 +51,8 @@ import java.util.List; * {@link BucketCollector}s. It is similar to the {@link MultiCollector} except that the * {@link #wrap} method filters out the {@link BucketCollector#NO_OP_COLLECTOR}s and not * the null ones. + * + * @opensearch.internal */ public class MultiBucketCollector extends BucketCollector { diff --git a/server/src/main/java/org/opensearch/search/aggregations/MultiBucketConsumerService.java b/server/src/main/java/org/opensearch/search/aggregations/MultiBucketConsumerService.java index ce9527e812d..d7c1796b171 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/MultiBucketConsumerService.java +++ b/server/src/main/java/org/opensearch/search/aggregations/MultiBucketConsumerService.java @@ -49,6 +49,8 @@ import java.util.function.IntConsumer; * The consumer is used by {@link BucketsAggregator} and {@link InternalMultiBucketAggregation} to limit the number of buckets created * in {@link Aggregator#buildAggregations} and {@link InternalAggregation#reduce}. * The limit can be set by changing the `search.max_buckets` cluster setting and defaults to 65535. + * + * @opensearch.internal */ public class MultiBucketConsumerService { public static final int DEFAULT_MAX_BUCKETS = 65535; diff --git a/server/src/main/java/org/opensearch/search/aggregations/NonCollectingAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/NonCollectingAggregator.java index 92a37b72646..34d1d48d8ce 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/NonCollectingAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/NonCollectingAggregator.java @@ -41,6 +41,8 @@ import java.util.Map; /** * An aggregator that is not collected, this can typically be used when running an aggregation over a field that doesn't have * a mapping. + * + * @opensearch.internal */ public abstract class NonCollectingAggregator extends AggregatorBase { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/ParsedAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/ParsedAggregation.java index 64d2779dceb..5d4803cd1eb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/ParsedAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/ParsedAggregation.java @@ -46,6 +46,8 @@ import java.util.Map; /** * An implementation of {@link Aggregation} that is parsed from a REST response. * Serves as a base class for all aggregation implementations that are parsed from REST. + * + * @opensearch.internal */ public abstract class ParsedAggregation implements Aggregation, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/ParsedMultiBucketAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/ParsedMultiBucketAggregation.java index 67310bc2a5a..6258295a2b7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/ParsedMultiBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/ParsedMultiBucketAggregation.java @@ -47,6 +47,11 @@ import java.util.function.Supplier; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * A multi-bucket agg that has been parsed + * + * @opensearch.internal + */ public abstract class ParsedMultiBucketAggregation extends ParsedAggregation implements MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregationBuilder.java index 3652f463509..6aba50ec912 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregationBuilder.java @@ -52,6 +52,8 @@ import java.util.Objects; /** * A factory that knows how to create an {@link PipelineAggregator} of a * specific type. + * + * @opensearch.internal */ public abstract class PipelineAggregationBuilder implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregatorBuilders.java b/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregatorBuilders.java index 3e8d3325fd6..b025860b9e6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregatorBuilders.java +++ b/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregatorBuilders.java @@ -53,6 +53,11 @@ import org.opensearch.search.sort.FieldSortBuilder; import java.util.List; import java.util.Map; +/** + * Builder utility class for pipeline aggs + * + * @opensearch.internal + */ public final class PipelineAggregatorBuilders { private PipelineAggregatorBuilders() {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/SearchContextAggregations.java b/server/src/main/java/org/opensearch/search/aggregations/SearchContextAggregations.java index 229f6bf118f..f51d5af23b0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/SearchContextAggregations.java +++ b/server/src/main/java/org/opensearch/search/aggregations/SearchContextAggregations.java @@ -35,6 +35,8 @@ import static org.opensearch.search.aggregations.MultiBucketConsumerService.Mult /** * The aggregation context that is part of the search context. + * + * @opensearch.internal */ public class SearchContextAggregations { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/BestBucketsDeferringCollector.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/BestBucketsDeferringCollector.java index 48e674d9772..f3addc9522a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/BestBucketsDeferringCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/BestBucketsDeferringCollector.java @@ -61,6 +61,8 @@ import java.util.Objects; * matches and then is able to replay a given subset of buckets which represent * the survivors from a pruning process performed by the aggregator that owns * this collector. + * + * @opensearch.internal */ public class BestBucketsDeferringCollector extends DeferringBucketCollector { static class Entry { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketUtils.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketUtils.java index 6dd064a5010..9a4f19910b3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketUtils.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketUtils.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.bucket; /** * Helper functions for common Bucketing functions + * + * @opensearch.internal */ public final class BucketUtils { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketsAggregator.java index f18f6fb8381..9e35a2745fc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/BucketsAggregator.java @@ -61,6 +61,11 @@ import java.util.function.IntConsumer; import java.util.function.LongUnaryOperator; import java.util.function.ToLongFunction; +/** + * Base class to collect all docs into buckets + * + * @opensearch.internal + */ public abstract class BucketsAggregator extends AggregatorBase { private final BigArrays bigArrays; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferableBucketAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferableBucketAggregator.java index 8efbad76b82..1ff065f39f3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferableBucketAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferableBucketAggregator.java @@ -45,6 +45,11 @@ import java.util.List; import java.util.Map; import java.util.function.BiConsumer; +/** + * Aggregator that defers collecting docs based on some metric + * + * @opensearch.internal + */ public abstract class DeferableBucketAggregator extends BucketsAggregator { /** * Wrapper that records collections. Non-null if any aggregations have diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferringBucketCollector.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferringBucketCollector.java index 8bb5074acba..d11fcfd104a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferringBucketCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/DeferringBucketCollector.java @@ -48,6 +48,8 @@ import java.util.Iterator; /** * A {@link BucketCollector} that records collected doc IDs and buckets and * allows to replay a subset of the collected buckets. + * + * @opensearch.internal */ public abstract class DeferringBucketCollector extends BucketCollector { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/InternalSingleBucketAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/InternalSingleBucketAggregation.java index bba1e526f69..e47053e7501 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/InternalSingleBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/InternalSingleBucketAggregation.java @@ -51,6 +51,8 @@ import java.util.function.Function; /** * A base class for all the single bucket aggregations. + * + * @opensearch.internal */ public abstract class InternalSingleBucketAggregation extends InternalAggregation implements SingleBucketAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/IteratorAndCurrent.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/IteratorAndCurrent.java index e0e14640d83..470fc0bc053 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/IteratorAndCurrent.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/IteratorAndCurrent.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.InternalMultiBucketAggregation; import java.util.Iterator; +/** + * Utility class for keeping track of a current item in an iterator + * + * @opensearch.internal + */ public class IteratorAndCurrent implements Iterator { private final Iterator iterator; private B current; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/MergingBucketsDeferringCollector.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/MergingBucketsDeferringCollector.java index 4edb13dbba6..8d35c1edc8c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/MergingBucketsDeferringCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/MergingBucketsDeferringCollector.java @@ -45,6 +45,8 @@ import java.util.function.LongUnaryOperator; * matches and then is able to replay a given subset of buckets. Exposes * mergeBuckets, which can be invoked by the aggregator when increasing the * rounding interval. + * + * @opensearch.internal */ public class MergingBucketsDeferringCollector extends BestBucketsDeferringCollector { public MergingBucketsDeferringCollector(SearchContext context, boolean isGlobal) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/MultiBucketsAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/MultiBucketsAggregation.java index 437fc8a372d..5bd014c6e4d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/MultiBucketsAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/MultiBucketsAggregation.java @@ -41,6 +41,8 @@ import java.util.List; /** * An aggregation that returns multiple buckets + * + * @opensearch.internal */ public interface MultiBucketsAggregation extends Aggregation { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/ParsedSingleBucketAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/ParsedSingleBucketAggregation.java index ddbbb3ed4f8..373099b367c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/ParsedSingleBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/ParsedSingleBucketAggregation.java @@ -47,6 +47,8 @@ import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedT /** * A base class for all the single bucket aggregations. + * + * @opensearch.internal */ public abstract class ParsedSingleBucketAggregation extends ParsedAggregation implements SingleBucketAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregation.java index b6e5acc39fe..af0babcc1c2 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregation.java @@ -38,6 +38,8 @@ import org.opensearch.search.aggregations.HasAggregations; /** * A single bucket aggregation + * + * @opensearch.internal */ public interface SingleBucketAggregation extends Aggregation, HasAggregations { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregator.java index b6b51f707ce..268e5f2aaf9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/SingleBucketAggregator.java @@ -33,5 +33,7 @@ package org.opensearch.search.aggregations.bucket; /** * A bucket aggregator that doesn't create new buckets. + * + * @opensearch.internal */ public interface SingleBucketAggregator {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrix.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrix.java index 4bf071aa23b..5cb8af37323 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrix.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrix.java @@ -40,6 +40,8 @@ import java.util.List; * A multi bucket aggregation where the buckets are defined by a set of filters * (a bucket is produced per filter plus a bucket for each non-empty filter * intersection so A, B and A&B). + * + * @opensearch.internal */ public interface AdjacencyMatrix extends MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregationBuilder.java index 640cceacb19..0eebd3e0bf3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregationBuilder.java @@ -59,6 +59,11 @@ import java.util.Map; import java.util.Map.Entry; import java.util.Objects; +/** + * Aggregation Builder for adjacency_matrix agg + * + * @opensearch.internal + */ public class AdjacencyMatrixAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "adjacency_matrix"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregator.java index b1054a01448..1cae870a378 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregator.java @@ -66,6 +66,7 @@ import static org.opensearch.index.query.AbstractQueryBuilder.parseInnerQueryBui /** * Aggregation for adjacency matrices. * + * @opensearch.internal */ public class AdjacencyMatrixAggregator extends BucketsAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregatorFactory.java index 7fffcff7b5d..fe1270e10c8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/AdjacencyMatrixAggregatorFactory.java @@ -48,6 +48,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregation Factory for adjacency_matrix agg + * + * @opensearch.internal + */ public class AdjacencyMatrixAggregatorFactory extends AggregatorFactory { private final String[] keys; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/InternalAdjacencyMatrix.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/InternalAdjacencyMatrix.java index 99a62621946..52a8d638d8e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/InternalAdjacencyMatrix.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/InternalAdjacencyMatrix.java @@ -48,6 +48,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Internal class used to represent an adjacency matrix as a collection of buckets + * + * @opensearch.internal + */ public class InternalAdjacencyMatrix extends InternalMultiBucketAggregation implements AdjacencyMatrix { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/ParsedAdjacencyMatrix.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/ParsedAdjacencyMatrix.java index 27e0bf40ca0..f211c072cbd 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/ParsedAdjacencyMatrix.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/adjacency/ParsedAdjacencyMatrix.java @@ -41,6 +41,11 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +/** + * Internal class used to hold a parsed adjacency matrix as a collection of buckets + * + * @opensearch.internal + */ public class ParsedAdjacencyMatrix extends ParsedMultiBucketAggregation implements AdjacencyMatrix { private Map bucketMap; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/BinaryValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/BinaryValuesSource.java index 44a29e2251b..54fd261f88c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/BinaryValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/BinaryValuesSource.java @@ -55,6 +55,8 @@ import java.util.function.LongConsumer; /** * A {@link SingleDimensionValuesSource} for binary source ({@link BytesRef}). + * + * @opensearch.internal */ class BinaryValuesSource extends SingleDimensionValuesSource { private final LongConsumer breakerConsumer; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregation.java index e245aefcbbc..06ec7f8b1ba 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregation.java @@ -39,6 +39,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregation creates a composite of multiple aggs + * + * @opensearch.internal + */ public interface CompositeAggregation extends MultiBucketsAggregation { interface Bucket extends MultiBucketsAggregation.Bucket { Map getKey(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationBuilder.java index 0dfc1de3503..8b07df3f689 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationBuilder.java @@ -55,6 +55,11 @@ import java.util.Set; import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; +/** + * Aggregation Builder for composite agg + * + * @opensearch.internal + */ public class CompositeAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "composite"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationFactory.java index d7383285ddd..09691a69c75 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregationFactory.java @@ -42,6 +42,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for composite agg + * + * @opensearch.internal + */ class CompositeAggregationFactory extends AggregatorFactory { private final int size; private final CompositeValuesSourceConfig[] sources; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregator.java index 6af887201d9..94fc48708c4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeAggregator.java @@ -86,6 +86,11 @@ import java.util.stream.Collectors; import static org.opensearch.search.aggregations.MultiBucketConsumerService.MAX_BUCKET_SETTING; +/** + * Main aggregator that aggregates docs from mulitple aggregations + * + * @opensearch.internal + */ final class CompositeAggregator extends BucketsAggregator { private final int size; private final List sourceNames; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeKey.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeKey.java index cb2801e625b..94b32c8c02f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeKey.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeKey.java @@ -41,6 +41,8 @@ import java.util.Arrays; /** * A key that is composed of multiple {@link Comparable} values. + * + * @opensearch.internal */ class CompositeKey implements Writeable { private final Comparable[] values; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesCollectorQueue.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesCollectorQueue.java index a7963532235..ac50869b5d7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesCollectorQueue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesCollectorQueue.java @@ -47,6 +47,8 @@ import java.util.Map; /** * A specialized {@link PriorityQueue} implementation for composite buckets. + * + * @opensearch.internal */ final class CompositeValuesCollectorQueue extends PriorityQueue implements Releasable { private class Slot { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceBuilder.java index 9ac43c812e4..7764d367a0c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceBuilder.java @@ -55,6 +55,8 @@ import static org.opensearch.search.aggregations.bucket.missing.MissingOrder.fro /** * A {@link ValuesSource} builder for {@link CompositeAggregationBuilder} + * + * @opensearch.internal */ public abstract class CompositeValuesSourceBuilder> implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceConfig.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceConfig.java index bcde67023b1..c85099976b2 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceConfig.java @@ -43,6 +43,11 @@ import org.opensearch.search.sort.SortOrder; import java.util.function.LongConsumer; +/** + * Field configuration class for composite values + * + * @opensearch.internal + */ public class CompositeValuesSourceConfig { @FunctionalInterface diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceParserHelper.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceParserHelper.java index c1e64f57c10..60d7f277f76 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceParserHelper.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/CompositeValuesSourceParserHelper.java @@ -50,6 +50,11 @@ import java.io.IOException; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * Helper class for obtaining values source parsers for different aggs + * + * @opensearch.internal + */ public class CompositeValuesSourceParserHelper { static , T> void declareValuesSourceFields(AbstractObjectParser objectParser) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java index acab1790bfa..ece8f506cbc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DateHistogramValuesSourceBuilder.java @@ -69,6 +69,8 @@ import java.util.function.LongConsumer; /** * A {@link CompositeValuesSourceBuilder} that builds a {@link RoundingValuesSource} from a {@link Script} or * a field name using the provided interval. + * + * @opensearch.internal */ public class DateHistogramValuesSourceBuilder extends CompositeValuesSourceBuilder implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DoubleValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DoubleValuesSource.java index fb94ff194b9..d05c78f5406 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DoubleValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/DoubleValuesSource.java @@ -50,6 +50,8 @@ import java.io.IOException; /** * A {@link SingleDimensionValuesSource} for doubles. + * + * @opensearch.internal */ class DoubleValuesSource extends SingleDimensionValuesSource { private final CheckedFunction docValuesFunc; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileGridValuesSourceBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileGridValuesSourceBuilder.java index 5d47a44a262..d4252d132ee 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileGridValuesSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileGridValuesSourceBuilder.java @@ -62,6 +62,11 @@ import java.util.Objects; import java.util.function.LongConsumer; import java.util.function.LongUnaryOperator; +/** + * Builds values source for geotile_grid agg + * + * @opensearch.internal + */ public class GeoTileGridValuesSourceBuilder extends CompositeValuesSourceBuilder { @FunctionalInterface public interface GeoTileCompositeSuppier { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileValuesSource.java index 2daddc9647f..819dfc573bb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GeoTileValuesSource.java @@ -49,6 +49,8 @@ import java.util.function.LongUnaryOperator; * * Since geotile values can be represented as long values, this class is almost the same as {@link LongValuesSource} * The main differences is {@link GeoTileValuesSource#setAfter(Comparable)} as it needs to accept geotile string values i.e. "zoom/x/y". + * + * @opensearch.internal */ class GeoTileValuesSource extends LongValuesSource { GeoTileValuesSource( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GlobalOrdinalValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GlobalOrdinalValuesSource.java index b4db4d8dd2a..3e5c53d470f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GlobalOrdinalValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/GlobalOrdinalValuesSource.java @@ -54,6 +54,8 @@ import static org.apache.lucene.index.SortedSetDocValues.NO_MORE_ORDS; /** * A {@link SingleDimensionValuesSource} for global ordinals. + * + * @opensearch.internal */ class GlobalOrdinalValuesSource extends SingleDimensionValuesSource { private final CheckedFunction docValuesFunc; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSource.java index 59625bc3300..d993578f757 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSource.java @@ -40,6 +40,11 @@ import org.opensearch.search.aggregations.support.ValuesSource; import java.io.IOException; +/** + * The values source for histogram agg + * + * @opensearch.internal + */ class HistogramValuesSource extends ValuesSource.Numeric { private final Numeric vs; private final double interval; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java index 1f1ed3b6254..f087d2d0495 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/HistogramValuesSourceBuilder.java @@ -57,6 +57,8 @@ import java.util.function.LongConsumer; /** * A {@link CompositeValuesSourceBuilder} that builds a {@link HistogramValuesSource} from another numeric values source * using the provided interval. + * + * @opensearch.internal */ public class HistogramValuesSourceBuilder extends CompositeValuesSourceBuilder { @FunctionalInterface diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/InternalComposite.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/InternalComposite.java index c102095d931..8b28c1a7c5a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/InternalComposite.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/InternalComposite.java @@ -58,6 +58,11 @@ import java.util.Objects; import java.util.PriorityQueue; import java.util.Set; +/** + * Internal coordination class for composite aggs + * + * @opensearch.internal + */ public class InternalComposite extends InternalMultiBucketAggregation implements CompositeAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/LongValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/LongValuesSource.java index 0ce147a138a..a7ed5050728 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/LongValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/LongValuesSource.java @@ -63,6 +63,8 @@ import java.util.function.ToLongFunction; /** * A {@link SingleDimensionValuesSource} for longs. + * + * @opensearch.internal */ class LongValuesSource extends SingleDimensionValuesSource { private final BigArrays bigArrays; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/ParsedComposite.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/ParsedComposite.java index 5cbda5dca13..965dc42a1e0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/ParsedComposite.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/ParsedComposite.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * A composite result parsed between nodes + * + * @opensearch.internal + */ public class ParsedComposite extends ParsedMultiBucketAggregation implements CompositeAggregation { private static final ObjectParser PARSER = new ObjectParser<>( ParsedComposite.class.getSimpleName(), diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/PointsSortedDocsProducer.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/PointsSortedDocsProducer.java index 8dbb902b961..3d6730203b6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/PointsSortedDocsProducer.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/PointsSortedDocsProducer.java @@ -45,6 +45,8 @@ import java.util.function.ToLongFunction; /** * A {@link SortedDocsProducer} that can sort documents based on numerics indexed in the provided field. + * + * @opensearch.internal */ class PointsSortedDocsProducer extends SortedDocsProducer { private final ToLongFunction bucketFunction; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/RoundingValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/RoundingValuesSource.java index fc0dfe9a5a0..3c710a6e1d5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/RoundingValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/RoundingValuesSource.java @@ -44,6 +44,8 @@ import java.io.IOException; /** * A wrapper for {@link ValuesSource.Numeric} that uses {@link Rounding} to transform the long values * produced by the underlying source. + * + * @opensearch.internal */ class RoundingValuesSource extends ValuesSource.Numeric { private final ValuesSource.Numeric vs; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SingleDimensionValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SingleDimensionValuesSource.java index 94b108e863e..747a7017ec8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SingleDimensionValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SingleDimensionValuesSource.java @@ -50,6 +50,8 @@ import static org.opensearch.search.aggregations.bucket.missing.MissingOrder.LAS /** * A source that can record and compare values of similar type. + * + * @opensearch.internal */ abstract class SingleDimensionValuesSource> implements Releasable { protected final BigArrays bigArrays; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SortedDocsProducer.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SortedDocsProducer.java index 9fe92c5f8d7..3cdbee6b119 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SortedDocsProducer.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/SortedDocsProducer.java @@ -47,6 +47,8 @@ import java.io.IOException; * A producer that visits composite buckets in the order of the value indexed in the leading source of the composite * definition. It can be used to control which documents should be collected to produce the top composite buckets * without visiting all documents in an index. + * + * @opensearch.internal */ abstract class SortedDocsProducer { protected final String field; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsSortedDocsProducer.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsSortedDocsProducer.java index c977ba3c7ec..89e7f4fae13 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsSortedDocsProducer.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsSortedDocsProducer.java @@ -45,6 +45,8 @@ import java.io.IOException; /** * A {@link SortedDocsProducer} that can sort documents based on terms indexed in the provided field. + * + * @opensearch.internal */ class TermsSortedDocsProducer extends SortedDocsProducer { TermsSortedDocsProducer(String field) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsValuesSourceBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsValuesSourceBuilder.java index c871e8d0c7d..ea1fc88e5cc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsValuesSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/composite/TermsValuesSourceBuilder.java @@ -58,6 +58,8 @@ import java.util.function.LongUnaryOperator; /** * A {@link CompositeValuesSourceBuilder} that builds a {@link ValuesSource} from a {@link Script} or * a field name. + * + * @opensearch.internal */ public class TermsValuesSourceBuilder extends CompositeValuesSourceBuilder { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filter.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filter.java index 44ccea1204f..213e76f19c5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filter.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filter.java @@ -35,5 +35,7 @@ import org.opensearch.search.aggregations.bucket.SingleBucketAggregation; /** * A {@code filter} aggregation. Defines a single bucket that holds all documents that match a specific filter. + * + * @opensearch.internal */ public interface Filter extends SingleBucketAggregation {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregationBuilder.java index 58c47fa3e5c..b1d829c3342 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregationBuilder.java @@ -51,6 +51,11 @@ import java.util.Objects; import static org.opensearch.index.query.AbstractQueryBuilder.parseInnerQueryBuilder; +/** + * Aggregation Builder for filter agg + * + * @opensearch.internal + */ public class FilterAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "filter"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregator.java index 28bfb607133..0f73d3453b6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregator.java @@ -51,6 +51,8 @@ import java.util.function.Supplier; /** * Aggregate all docs that match a filter. + * + * @opensearch.internal */ public class FilterAggregator extends BucketsAggregator implements SingleBucketAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregatorFactory.java index 07823f19e34..4ab573cf0a6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FilterAggregatorFactory.java @@ -48,6 +48,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for filter agg + * + * @opensearch.internal + */ public class FilterAggregatorFactory extends AggregatorFactory { private Weight weight; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filters.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filters.java index b70cbd2586e..25153eb86d1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filters.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/Filters.java @@ -39,6 +39,8 @@ import java.util.List; /** * A multi bucket aggregation where the buckets are defined by a set of filters (a bucket per filter). Each bucket * will collect all documents matching its filter. + * + * @opensearch.internal */ public interface Filters extends MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregationBuilder.java index a1a5d53bf2b..cb491083fbf 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregationBuilder.java @@ -59,6 +59,11 @@ import java.util.Objects; import static org.opensearch.index.query.AbstractQueryBuilder.parseInnerQueryBuilder; +/** + * Aggregation Builder for filters agg + * + * @opensearch.internal + */ public class FiltersAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "filters"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregator.java index e13a3c75576..1b58d5372c5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregator.java @@ -60,6 +60,11 @@ import java.util.Map; import java.util.Objects; import java.util.function.Supplier; +/** + * Aggregate all docs that match multiple filters. + * + * @opensearch.internal + */ public class FiltersAggregator extends BucketsAggregator { public static final ParseField FILTERS_FIELD = new ParseField("filters"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregatorFactory.java index 50125c4cc50..8741213f988 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/FiltersAggregatorFactory.java @@ -49,6 +49,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregation Factory for filters agg + * + * @opensearch.internal + */ public class FiltersAggregatorFactory extends AggregatorFactory { private final String[] keys; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilter.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilter.java index fc408366a83..e3cf61a4ef8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilter.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilter.java @@ -39,6 +39,11 @@ import org.opensearch.search.aggregations.bucket.InternalSingleBucketAggregation import java.io.IOException; import java.util.Map; +/** + * Implementation of filter agg + * + * @opensearch.internal + */ public class InternalFilter extends InternalSingleBucketAggregation implements Filter { InternalFilter(String name, long docCount, InternalAggregations subAggregations, Map metadata) { super(name, docCount, subAggregations, metadata); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilters.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilters.java index 3989400bb49..ba7cb41f63a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilters.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/InternalFilters.java @@ -47,6 +47,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of filters agg + * + * @opensearch.internal + */ public class InternalFilters extends InternalMultiBucketAggregation implements Filters { public static class InternalBucket extends InternalMultiBucketAggregation.InternalBucket implements Filters.Bucket { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilter.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilter.java index 1d922949d99..b31df2cb178 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilter.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilter.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.bucket.ParsedSingleBucketAggregation; import java.io.IOException; +/** + * A filter agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedFilter extends ParsedSingleBucketAggregation implements Filter { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilters.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilters.java index bcecac0ac03..0ac821b6c8a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilters.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/filter/ParsedFilters.java @@ -48,6 +48,11 @@ import java.util.Map; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * A filters agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedFilters extends ParsedMultiBucketAggregation implements Filters { private Map bucketMap; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BoundedCellValues.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BoundedCellValues.java index cc4f5835cab..ba824fc8f21 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BoundedCellValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BoundedCellValues.java @@ -39,6 +39,8 @@ import org.opensearch.index.fielddata.MultiGeoPointValues; * according to whether they are within the specified {@link GeoBoundingBox}. * * The specified bounding box is assumed to be bounded. + * + * @opensearch.internal */ class BoundedCellValues extends CellValues { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BucketPriorityQueue.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BucketPriorityQueue.java index 3a8245a52ad..d6cfde0c46e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BucketPriorityQueue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/BucketPriorityQueue.java @@ -33,6 +33,11 @@ package org.opensearch.search.aggregations.bucket.geogrid; import org.apache.lucene.util.PriorityQueue; +/** + * Internal priority queue for computing geogrid relations + * + * @opensearch.internal + */ class BucketPriorityQueue extends PriorityQueue { BucketPriorityQueue(int size) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellIdSource.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellIdSource.java index c9ea7696cd7..bf47fe21807 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellIdSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellIdSource.java @@ -42,6 +42,8 @@ import org.opensearch.search.aggregations.support.ValuesSource; /** * Wrapper class to help convert {@link MultiGeoPointValues} * to numeric long values for bucketing. + * + * @opensearch.internal */ public class CellIdSource extends ValuesSource.Numeric { private final ValuesSource.GeoPoint valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellValues.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellValues.java index 2e8344f203a..9dc357659aa 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/CellValues.java @@ -40,6 +40,8 @@ import java.io.IOException; * Class representing the long-encoded grid-cells belonging to * the geo-doc-values. Class must encode the values and then * sort them in order to account for the cells correctly. + * + * @opensearch.internal */ abstract class CellValues extends AbstractSortingNumericDocValues { private MultiGeoPointValues geoValues; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGrid.java index 7521f9f58bd..cfdb08f9ee3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGrid.java @@ -38,6 +38,8 @@ import java.util.List; /** * A geo-grid aggregation. Defines multiple buckets, each representing a cell in a geo-grid of a specific * precision. + * + * @opensearch.internal */ public interface GeoGrid extends MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregationBuilder.java index 5ec17c951d1..c235626e09a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregationBuilder.java @@ -57,6 +57,11 @@ import java.util.Map; import java.util.Objects; import java.util.function.Function; +/** + * Base Aggregation Builder for geohash_grid and geotile_grid aggs + * + * @opensearch.internal + */ public abstract class GeoGridAggregationBuilder extends ValuesSourceAggregationBuilder { /* recognized field names in JSON */ static final ParseField FIELD_PRECISION = new ParseField("precision"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregator.java index 7eb05adf78e..1ef8ba6c697 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoGridAggregator.java @@ -54,6 +54,8 @@ import java.util.Map; /** * Aggregates data expressed as longs (for efficiency's sake) but formats results as aggregation-specific strings. + * + * @opensearch.internal */ public abstract class GeoGridAggregator extends BucketsAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregationBuilder.java index a1ae76eb034..4049bf2c736 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregationBuilder.java @@ -48,6 +48,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceRegistry; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for geohash_grid + * + * @opensearch.internal + */ public class GeoHashGridAggregationBuilder extends GeoGridAggregationBuilder { public static final String NAME = "geohash_grid"; public static final int DEFAULT_PRECISION = 5; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregator.java index 74c81704587..1106320c743 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregator.java @@ -44,6 +44,8 @@ import java.util.Map; /** * Aggregates data expressed as GeoHash longs (for efficiency's sake) but formats results as Geohash strings. + * + * @opensearch.internal */ public class GeoHashGridAggregator extends GeoGridAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregatorFactory.java index a52ee2018fd..cdc801aaedf 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoHashGridAggregatorFactory.java @@ -53,6 +53,11 @@ import java.util.Map; import static java.util.Collections.emptyList; +/** + * Aggregation Factory for geohash_grid agg + * + * @opensearch.internal + */ public class GeoHashGridAggregatorFactory extends ValuesSourceAggregatorFactory { private final int precision; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregationBuilder.java index 6828077cd47..f73360e3cb8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregationBuilder.java @@ -47,6 +47,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceRegistry; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for geotile_grid agg + * + * @opensearch.internal + */ public class GeoTileGridAggregationBuilder extends GeoGridAggregationBuilder { public static final String NAME = "geotile_grid"; public static final int DEFAULT_PRECISION = 7; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregator.java index 390f6136862..7a2b908148c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregator.java @@ -45,6 +45,8 @@ import java.util.Map; /** * Aggregates data expressed as geotile longs (for efficiency's sake) but formats results as geotile strings. + * + * @opensearch.internal */ public class GeoTileGridAggregator extends GeoGridAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregatorFactory.java index 616451474ab..ef8cd11a224 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileGridAggregatorFactory.java @@ -51,6 +51,11 @@ import java.io.IOException; import java.util.Collections; import java.util.Map; +/** + * Aggregation Factory for geo_tile grid agg + * + * @opensearch.internal + */ public class GeoTileGridAggregatorFactory extends ValuesSourceAggregatorFactory { private final int precision; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileUtils.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileUtils.java index d520cc995bb..5498b2b1a71 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileUtils.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/GeoTileUtils.java @@ -54,6 +54,8 @@ import static org.opensearch.common.geo.GeoUtils.normalizeLon; * bits 58..63 -- zoom (0..29) * bits 29..57 -- X tile index (0..2^zoom) * bits 0..28 -- Y tile index (0..2^zoom) + * + * @opensearch.internal */ public final class GeoTileUtils { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGrid.java index e7fed7c735b..94a5ad57178 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGrid.java @@ -53,6 +53,8 @@ import static java.util.Collections.unmodifiableList; * Represents a grid of cells where each cell's location is determined by a specific geo hashing algorithm. * All geo-grid hash-encoding in a grid are of the same precision and held internally as a single long * for efficiency's sake. + * + * @opensearch.internal */ public abstract class InternalGeoGrid extends InternalMultiBucketAggregation< InternalGeoGrid, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGridBucket.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGridBucket.java index 0ddfed84fbe..a187bfefb66 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGridBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoGridBucket.java @@ -42,6 +42,11 @@ import org.opensearch.search.aggregations.InternalMultiBucketAggregation; import java.io.IOException; import java.util.Objects; +/** + * Base implementation of geogrid aggs + * + * @opensearch.internal + */ public abstract class InternalGeoGridBucket extends InternalMultiBucketAggregation.InternalBucket implements GeoGrid.Bucket, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGrid.java index bae4f99d3bb..7811b8774d0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGrid.java @@ -42,6 +42,8 @@ import java.util.Map; * Represents a grid of cells where each cell's location is determined by a geohash. * All geohashes in a grid are of the same precision and held internally as a single long * for efficiency's sake. + * + * @opensearch.internal */ public class InternalGeoHashGrid extends InternalGeoGrid { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGridBucket.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGridBucket.java index a5bead1f172..f9c45dc41ce 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGridBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoHashGridBucket.java @@ -38,6 +38,11 @@ import org.opensearch.search.aggregations.InternalAggregations; import java.io.IOException; +/** + * Implementation of geohash grid bucket + * + * @opensearch.internal + */ public class InternalGeoHashGridBucket extends InternalGeoGridBucket { InternalGeoHashGridBucket(long hashAsLong, long docCount, InternalAggregations aggregations) { super(hashAsLong, docCount, aggregations); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGrid.java index d7ff2c0a2cd..efbd9a05d6a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGrid.java @@ -42,6 +42,8 @@ import java.util.Map; * Represents a grid of cells where each cell's location is determined by a geohash. * All geohashes in a grid are of the same precision and held internally as a single long * for efficiency's sake. + * + * @opensearch.internal */ public class InternalGeoTileGrid extends InternalGeoGrid { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGridBucket.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGridBucket.java index b08ef55a71f..f200f55232e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGridBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/InternalGeoTileGridBucket.java @@ -38,6 +38,11 @@ import org.opensearch.search.aggregations.InternalAggregations; import java.io.IOException; +/** + * Implementation of geotile grid bucket + * + * @opensearch.internal + */ public class InternalGeoTileGridBucket extends InternalGeoGridBucket { InternalGeoTileGridBucket(long hashAsLong, long docCount, InternalAggregations aggregations) { super(hashAsLong, docCount, aggregations); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGrid.java index 59681a52b1c..3f85cf350c8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGrid.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.List; import java.util.function.Supplier; +/** + * A geo grid result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedGeoGrid extends ParsedMultiBucketAggregation implements GeoGrid { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGridBucket.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGridBucket.java index f09eb46fd8a..08e5c15188e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGridBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoGridBucket.java @@ -37,6 +37,11 @@ import org.opensearch.search.aggregations.ParsedMultiBucketAggregation; import java.io.IOException; +/** + * A single geo grid bucket result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedGeoGridBucket extends ParsedMultiBucketAggregation.ParsedBucket implements GeoGrid.Bucket { protected String hashAsString; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGrid.java index 189bfb4b58c..f20f972c1ce 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGrid.java @@ -37,6 +37,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A geohash grid result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGeoHashGrid extends ParsedGeoGrid { private static final ObjectParser PARSER = createParser( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGridBucket.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGridBucket.java index 3ed6cfe41ba..05c7a1c8d16 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGridBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoHashGridBucket.java @@ -36,6 +36,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A single geohash grid bucket result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGeoHashGridBucket extends ParsedGeoGridBucket { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGrid.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGrid.java index 011fe2c9102..06915cc4210 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGrid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGrid.java @@ -37,6 +37,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A geotile grid result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGeoTileGrid extends ParsedGeoGrid { private static final ObjectParser PARSER = createParser( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGridBucket.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGridBucket.java index 5b2bdd163d8..c8dec16f322 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGridBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/ParsedGeoTileGridBucket.java @@ -37,6 +37,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A single geotile grid bucket result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGeoTileGridBucket extends ParsedGeoGridBucket { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/UnboundedCellValues.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/UnboundedCellValues.java index 7dd7f155fb4..f5a139cdb8d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/UnboundedCellValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/geogrid/UnboundedCellValues.java @@ -37,6 +37,8 @@ import org.opensearch.index.fielddata.MultiGeoPointValues; /** * Class representing {@link CellValues} that are unbounded by any * {@link GeoBoundingBox}. + * + * @opensearch.internal */ class UnboundedCellValues extends CellValues { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/Global.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/Global.java index 4a5a484ea75..9481d134adc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/Global.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/Global.java @@ -35,5 +35,7 @@ import org.opensearch.search.aggregations.bucket.SingleBucketAggregation; /** * A {@code global} aggregation. Defines a single bucket the holds all the documents in the search context. + * + * @opensearch.internal */ public interface Global extends SingleBucketAggregation {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregationBuilder.java index ad3498043c5..2e8105b569a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregationBuilder.java @@ -45,6 +45,11 @@ import org.opensearch.search.aggregations.AggregatorFactory; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for global agg + * + * @opensearch.internal + */ public class GlobalAggregationBuilder extends AbstractAggregationBuilder { public static GlobalAggregationBuilder parse(XContentParser parser, String aggregationName) throws IOException { parser.nextToken(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregator.java index 7b3c9399225..96cf8f8f766 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregator.java @@ -44,6 +44,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs from the global search scope. + * + * @opensearch.internal + */ public class GlobalAggregator extends BucketsAggregator implements SingleBucketAggregator { public GlobalAggregator(String name, AggregatorFactories subFactories, SearchContext aggregationContext, Map metadata) diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregatorFactory.java index 102e1befb08..419ae9f16d9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/GlobalAggregatorFactory.java @@ -43,6 +43,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for global agg + * + * @opensearch.internal + */ public class GlobalAggregatorFactory extends AggregatorFactory { public GlobalAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/InternalGlobal.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/InternalGlobal.java index 20f49e4ce00..68e4f1d4e2c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/InternalGlobal.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/InternalGlobal.java @@ -41,6 +41,8 @@ import java.util.Map; /** * A global scope get (the document set on which we aggregate is all documents in the search context (ie. index + type) * regardless the query. + * + * @opensearch.internal */ public class InternalGlobal extends InternalSingleBucketAggregation implements Global { InternalGlobal(String name, long docCount, InternalAggregations aggregations, Map metadata) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/ParsedGlobal.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/ParsedGlobal.java index 2e97e76ad3e..ae96e509b39 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/global/ParsedGlobal.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/global/ParsedGlobal.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.bucket.ParsedSingleBucketAggregation; import java.io.IOException; +/** + * A global agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGlobal extends ParsedSingleBucketAggregation implements Global { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AbstractHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AbstractHistogramAggregator.java index adf3d973a26..d3a4a51e5b6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AbstractHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AbstractHistogramAggregator.java @@ -55,6 +55,8 @@ import static org.opensearch.search.aggregations.bucket.histogram.DoubleBounds.g /** * Base class for functionality shared between aggregators for this * {@code histogram} aggregation. + * + * @opensearch.internal */ public abstract class AbstractHistogramAggregator extends BucketsAggregator { protected final DocValueFormat formatter; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregationBuilder.java index a9f5339ad4f..93216171744 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregationBuilder.java @@ -60,6 +60,11 @@ import java.util.HashMap; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for auto_gate_histogram agg + * + * @opensearch.internal + */ public class AutoDateHistogramAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "auto_date_histogram"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregator.java index 76812334ff2..587e8385680 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregator.java @@ -76,6 +76,8 @@ import java.util.function.LongToIntFunction; * standpoint but the simpler implementation is between 7% and 15% faster * when you can use it. This is an important aggregation and we need that * performance. + * + * @opensearch.internal */ abstract class AutoDateHistogramAggregator extends DeferableBucketAggregator { static AutoDateHistogramAggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorFactory.java index 3cb2a3a7d09..7434ef84ee9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorFactory.java @@ -50,6 +50,11 @@ import java.util.Arrays; import java.util.Map; import java.util.function.Function; +/** + * Aggregation Factory for auto_date_histogram + * + * @opensearch.internal + */ public final class AutoDateHistogramAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorSupplier.java index fe48c4ba953..a9b62019bde 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/AutoDateHistogramAggregatorSupplier.java @@ -44,6 +44,11 @@ import java.io.IOException; import java.util.Map; import java.util.function.Function; +/** + * Aggregator supplier interface for auto_date_histogram agg + * + * @opensearch.internal + */ @FunctionalInterface public interface AutoDateHistogramAggregatorSupplier { Aggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationBuilder.java index c416f6657b9..f8952ddca4c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationBuilder.java @@ -65,6 +65,8 @@ import static java.util.Collections.unmodifiableMap; /** * A builder for histograms on date fields. + * + * @opensearch.internal */ public class DateHistogramAggregationBuilder extends ValuesSourceAggregationBuilder implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationSupplier.java index dab69e86e41..146eeedfbe9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregationSupplier.java @@ -44,6 +44,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for date_histogram agg + * + * @opensearch.internal + */ @FunctionalInterface public interface DateHistogramAggregationSupplier { Aggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregator.java index d243c46a7a1..295dfec639d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregator.java @@ -62,6 +62,8 @@ import java.util.function.BiConsumer; * {@link Rounding}. * * @see Rounding + * + * @opensearch.internal */ class DateHistogramAggregator extends BucketsAggregator implements SizedBucketAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregatorFactory.java index 900262aaa10..eb22a857643 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramAggregatorFactory.java @@ -49,6 +49,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for date_histogram agg + * + * @opensearch.internal + */ public final class DateHistogramAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramInterval.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramInterval.java index f3d3a567859..c5ef4e7a075 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramInterval.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateHistogramInterval.java @@ -46,6 +46,8 @@ import java.util.Objects; /** * The interval the date histogram is based on. + * + * @opensearch.internal */ public class DateHistogramInterval implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalConsumer.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalConsumer.java index 79581fd3137..a2c63cf25c0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalConsumer.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalConsumer.java @@ -37,6 +37,8 @@ package org.opensearch.search.aggregations.bucket.histogram; * * Provides definitions for the new fixed and calendar intervals, and deprecated * defintions for the old interval/dateHisto interval parameters + * + * @opensearch.internal */ public interface DateIntervalConsumer { @Deprecated diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalWrapper.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalWrapper.java index fb1287ac171..6c187f7924a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalWrapper.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateIntervalWrapper.java @@ -64,6 +64,8 @@ import java.util.Objects; * After the deprecated parameters are removed, this class can be simplified greatly. The legacy options * will be removed, and the mutual-exclusion checks can be done in the setters directly removing the need * for the enum and the complicated "state machine" logic + * + * @opensearch.internal */ public class DateIntervalWrapper implements ToXContentFragment, Writeable { private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(DateHistogramAggregationBuilder.class); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateRangeHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateRangeHistogramAggregator.java index d81ac0ae44a..f70a5bb5373 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateRangeHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DateRangeHistogramAggregator.java @@ -69,6 +69,8 @@ import static java.lang.Long.min; * {@link Rounding}. * * @see Rounding + * + * @opensearch.internal */ class DateRangeHistogramAggregator extends BucketsAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DoubleBounds.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DoubleBounds.java index a8229765179..c2e44c55c39 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DoubleBounds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/DoubleBounds.java @@ -52,6 +52,8 @@ import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalCo * * This class is similar to {@link LongBounds} used in date histograms, but is using longs to store data. LongBounds and DoubleBounds are * not used interchangeably and therefore don't share any common interfaces except for serialization. + * + * @opensearch.internal */ public class DoubleBounds implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/Histogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/Histogram.java index 85c53243f41..0d9eb9b82dd 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/Histogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/Histogram.java @@ -38,6 +38,8 @@ import java.util.List; /** * A {@code histogram} aggregation. Defines multiple buckets, each representing an interval in a histogram. + * + * @opensearch.internal */ public interface Histogram extends MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregationBuilder.java index 1ca2988a3e7..ceb77099070 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregationBuilder.java @@ -60,6 +60,8 @@ import java.util.Objects; /** * A builder for histograms on numeric fields. This builder can operate on either base numeric fields, or numeric range fields. IP range * fields are unsupported, and will throw at the factory layer. + * + * @opensearch.internal */ public class HistogramAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "histogram"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorFactory.java index 4978998e082..722bf872016 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorFactory.java @@ -51,6 +51,8 @@ import java.util.Map; /** * Constructs the per-shard aggregator instance for histogram aggregation. Selects the numeric or range field implementation based on the * field type. + * + * @opensearch.internal */ public final class HistogramAggregatorFactory extends ValuesSourceAggregatorFactory { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorSupplier.java index 68af0b10c12..44626052097 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramAggregatorSupplier.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for histogram aggs + * + * @opensearch.internal + */ public interface HistogramAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramFactory.java index d5566f540b5..4488b5bd220 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/HistogramFactory.java @@ -38,7 +38,11 @@ import org.opensearch.search.aggregations.bucket.MultiBucketsAggregation; import java.util.List; -/** Implemented by histogram aggregations and used by pipeline aggregations to insert buckets. */ +/** + * Implemented by histogram aggregations and used by pipeline aggregations to insert buckets. + * + * @opensearch.internal + */ // public so that pipeline aggs can use this API: can we fix it? public interface HistogramFactory { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalAutoDateHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalAutoDateHistogram.java index 83cd22934ab..55ef48211bc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalAutoDateHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalAutoDateHistogram.java @@ -59,6 +59,8 @@ import java.util.Objects; /** * Implementation of {@link Histogram}. + * + * @opensearch.internal */ public final class InternalAutoDateHistogram extends InternalMultiBucketAggregation< InternalAutoDateHistogram, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalDateHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalDateHistogram.java index 9f26242e203..068d6533c59 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalDateHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalDateHistogram.java @@ -60,6 +60,8 @@ import java.util.Objects; /** * Implementation of {@link Histogram}. + * + * @opensearch.internal */ public final class InternalDateHistogram extends InternalMultiBucketAggregation implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalHistogram.java index 98e1aadd8c1..c11f483392c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalHistogram.java @@ -57,6 +57,8 @@ import java.util.Objects; /** * Implementation of {@link Histogram}. + * + * @opensearch.internal */ public final class InternalHistogram extends InternalMultiBucketAggregation implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalVariableWidthHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalVariableWidthHistogram.java index 5a103771356..ec4be47e4a6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalVariableWidthHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/InternalVariableWidthHistogram.java @@ -53,6 +53,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Aggregator supplier interface for an internal variable width histogram agg + * + * @opensearch.internal + */ public class InternalVariableWidthHistogram extends InternalMultiBucketAggregation< InternalVariableWidthHistogram, InternalVariableWidthHistogram.Bucket> implements Histogram, HistogramFactory { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/LongBounds.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/LongBounds.java index 5e8087ef53e..ad287a158db 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/LongBounds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/LongBounds.java @@ -57,6 +57,8 @@ import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalCo * * This class is similar to {@link DoubleBounds} used in histograms, but is using longs to store data. LongBounds and DoubleBounds are * * not used interchangeably and therefore don't share any common interfaces except for serialization. + * + * @opensearch.internal */ public class LongBounds implements ToXContentFragment, Writeable { static final ParseField MIN_FIELD = new ParseField("min"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/NumericHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/NumericHistogramAggregator.java index e6cddafc086..1cd44be4319 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/NumericHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/NumericHistogramAggregator.java @@ -53,6 +53,8 @@ import java.util.Map; * {@code offset} and {@code value}, it returns the highest number that can be * written as {@code interval * x + offset} and yet is less than or equal to * {@code value}. + * + * @opensearch.internal */ public class NumericHistogramAggregator extends AbstractHistogramAggregator { private final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedAutoDateHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedAutoDateHistogram.java index 671f2700ace..83f776d34a1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedAutoDateHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedAutoDateHistogram.java @@ -43,6 +43,11 @@ import java.time.Instant; import java.time.ZoneOffset; import java.util.List; +/** + * A auto date histogram result parsed between nodes + * + * @opensearch.internal + */ public class ParsedAutoDateHistogram extends ParsedMultiBucketAggregation implements Histogram { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedDateHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedDateHistogram.java index efb681130ee..248f41f2130 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedDateHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedDateHistogram.java @@ -42,6 +42,11 @@ import java.time.Instant; import java.time.ZoneOffset; import java.util.List; +/** + * A date histogram result parsed between nodes + * + * @opensearch.internal + */ public class ParsedDateHistogram extends ParsedMultiBucketAggregation implements Histogram { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedHistogram.java index 354c95efa98..1cc7865d22f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedHistogram.java @@ -39,6 +39,11 @@ import org.opensearch.search.aggregations.ParsedMultiBucketAggregation; import java.io.IOException; import java.util.List; +/** + * A histogram result parsed between nodes + * + * @opensearch.internal + */ public class ParsedHistogram extends ParsedMultiBucketAggregation implements Histogram { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedVariableWidthHistogram.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedVariableWidthHistogram.java index 727e34d3e76..c03221af74c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedVariableWidthHistogram.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/ParsedVariableWidthHistogram.java @@ -46,6 +46,11 @@ import java.util.List; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * A variable width histogram result parsed between nodes + * + * @opensearch.internal + */ public class ParsedVariableWidthHistogram extends ParsedMultiBucketAggregation implements Histogram { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/RangeHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/RangeHistogramAggregator.java index 919815c988f..fe77033f5a2 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/RangeHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/RangeHistogramAggregator.java @@ -51,6 +51,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregate all docs that match a given range + * + * @opensearch.internal + */ public class RangeHistogramAggregator extends AbstractHistogramAggregator { private final ValuesSource.Range valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregator.java index 21b085e2973..cfa154a6e90 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregator.java @@ -36,6 +36,8 @@ import org.opensearch.common.Rounding; /** * An aggregator capable of reporting bucket sizes in milliseconds. Used by RateAggregator for calendar-based buckets. + * + * @opensearch.internal */ public interface SizedBucketAggregator { double bucketSize(long bucket, Rounding.DateTimeUnit unit); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregatorBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregatorBuilder.java index 9edb76443f9..a87de32d0e1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregatorBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/SizedBucketAggregatorBuilder.java @@ -36,6 +36,8 @@ import java.util.concurrent.TimeUnit; /** * An aggregator capable of reporting bucket sizes in milliseconds. Used by RateAggregator for calendar-based buckets. + * + * @opensearch.internal */ public interface SizedBucketAggregatorBuilder { double calendarDivider(TimeUnit timeUnit); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregationBuilder.java index 169d219e76c..55b3903efa3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregationBuilder.java @@ -55,6 +55,11 @@ import java.util.Locale; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for variable_width_histogram agg + * + * @opensearch.internal + */ public class VariableWidthHistogramAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "variable_width_histogram"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregator.java index 2dc9d50e100..11ff7dbc407 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregator.java @@ -66,6 +66,11 @@ import java.util.Map; import java.util.function.Function; import java.util.function.LongUnaryOperator; +/** + * Aggregate all docs that match variable width buckets. + * + * @opensearch.internal + */ public class VariableWidthHistogramAggregator extends DeferableBucketAggregator { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorFactory.java index 644c41cc6f5..d9d9a74eb95 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for variable_width_histogram + * + * @opensearch.internal + */ public class VariableWidthHistogramAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorSupplier.java index 80936ef0c27..153d7f1df7b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/histogram/VariableWidthHistogramAggregatorSupplier.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for variable_width_histogram agg + * + * @opensearch.internal + */ @FunctionalInterface public interface VariableWidthHistogramAggregatorSupplier { Aggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/Missing.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/Missing.java index 3f2a4197680..9918ae1f4b3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/Missing.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/Missing.java @@ -35,5 +35,7 @@ import org.opensearch.search.aggregations.bucket.SingleBucketAggregation; /** * A {@code missing} aggregation. Defines a single bucket of all documents that are missing a specific field. + * + * @opensearch.internal */ public interface Missing extends SingleBucketAggregation {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregationBuilder.java index 75a74a02d3d..b322b13bb33 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregationBuilder.java @@ -51,6 +51,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for missing agg + * + * @opensearch.internal + */ public class MissingAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "missing"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregator.java index f189c3cf5e1..5f7b4b5a91e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregator.java @@ -48,6 +48,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs that are missing a value. + * + * @opensearch.internal + */ public class MissingAggregator extends BucketsAggregator implements SingleBucketAggregator { private final ValuesSource valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorFactory.java index 37b3f784e87..cfa2bd3f709 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for missing agg + * + * @opensearch.internal + */ public class MissingAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorSupplier.java index 6b273514bb6..f9d99b1c722 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingAggregatorSupplier.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for missing agg + * + * @opensearch.internal + */ @FunctionalInterface public interface MissingAggregatorSupplier { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingOrder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingOrder.java index 06086f507f6..b0b987065c6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingOrder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/MissingOrder.java @@ -18,6 +18,8 @@ import java.util.Locale; /** * Composite Aggregation Missing bucket order. + * + * @opensearch.internal */ public enum MissingOrder implements Writeable { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/ParsedMissing.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/ParsedMissing.java index 1a4a88e6975..81a57818a0d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/ParsedMissing.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/ParsedMissing.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.bucket.ParsedSingleBucketAggregation; import java.io.IOException; +/** + * A missing agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedMissing extends ParsedSingleBucketAggregation implements Missing { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalNested.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalNested.java index a90134ebb87..c3346c66d17 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalNested.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalNested.java @@ -40,6 +40,8 @@ import java.util.Map; /** * Result of the {@link NestedAggregator}. + * + * @opensearch.internal */ public class InternalNested extends InternalSingleBucketAggregation implements Nested { InternalNested(String name, long docCount, InternalAggregations aggregations, Map metadata) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalReverseNested.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalReverseNested.java index 1754a856b7a..95b4714bdba 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalReverseNested.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/InternalReverseNested.java @@ -40,6 +40,8 @@ import java.util.Map; /** * Result of the {@link ReverseNestedAggregator}. + * + * @opensearch.internal */ public class InternalReverseNested extends InternalSingleBucketAggregation implements ReverseNested { public InternalReverseNested(String name, long docCount, InternalAggregations aggregations, Map metadata) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/Nested.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/Nested.java index 9e3775bb095..e5d52e9e01e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/Nested.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/Nested.java @@ -35,5 +35,7 @@ import org.opensearch.search.aggregations.bucket.SingleBucketAggregation; /** * A {@code nested} aggregation. Defines a single bucket that holds all the nested documents of a specific path. + * + * @opensearch.internal */ public interface Nested extends SingleBucketAggregation {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregationBuilder.java index 385ce67ffef..b99336de169 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregationBuilder.java @@ -49,6 +49,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for nested agg + * + * @opensearch.internal + */ public class NestedAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "nested"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregator.java index a003f138025..dc536aebc0c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregator.java @@ -60,6 +60,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs that match a nested path + * + * @opensearch.internal + */ public class NestedAggregator extends BucketsAggregator implements SingleBucketAggregator { static final ParseField PATH_FIELD = new ParseField("path"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregatorFactory.java index 0102d172435..22b87280c85 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/NestedAggregatorFactory.java @@ -45,6 +45,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for nested agg + * + * @opensearch.internal + */ public class NestedAggregatorFactory extends AggregatorFactory { private final ObjectMapper parentObjectMapper; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedNested.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedNested.java index 01e7593ecb9..abf069c662d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedNested.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedNested.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.bucket.ParsedSingleBucketAggregation; import java.io.IOException; +/** + * A nested agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedNested extends ParsedSingleBucketAggregation implements Nested { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedReverseNested.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedReverseNested.java index 66a789f4c35..cd0cf8cb971 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedReverseNested.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ParsedReverseNested.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.bucket.ParsedSingleBucketAggregation; import java.io.IOException; +/** + * A reverse nested agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedReverseNested extends ParsedSingleBucketAggregation implements ReverseNested { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNested.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNested.java index 871c185d502..1bc2383573e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNested.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNested.java @@ -36,5 +36,7 @@ import org.opensearch.search.aggregations.bucket.SingleBucketAggregation; /** * A {@code reverse nested} aggregation. Defines a single bucket that holds all the parent documents for a specific nested path. + * + * @opensearch.internal */ public interface ReverseNested extends SingleBucketAggregation {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregationBuilder.java index 72854b36f21..42105ebc71a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregationBuilder.java @@ -50,6 +50,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for reverse_nested agg + * + * @opensearch.internal + */ public class ReverseNestedAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "reverse_nested"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregator.java index 689304215e9..0513e9235e3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregator.java @@ -53,6 +53,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregates documents that match a nested path. + * + * @opensearch.internal + */ public class ReverseNestedAggregator extends BucketsAggregator implements SingleBucketAggregator { static final ParseField PATH_FIELD = new ParseField("path"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregatorFactory.java index 202645c8638..2929df697ea 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/nested/ReverseNestedAggregatorFactory.java @@ -45,6 +45,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for reverse_nested agg + * + * @opensearch.internal + */ public class ReverseNestedAggregatorFactory extends AggregatorFactory { private final boolean unmapped; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeAggregatorFactory.java index 973ef10881e..90ae2e994ca 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeAggregatorFactory.java @@ -49,6 +49,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base Aggregation Factory for range aggs + * + * @opensearch.internal + */ public class AbstractRangeAggregatorFactory extends ValuesSourceAggregatorFactory { private final InternalRange.Factory rangeFactory; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeBuilder.java index 083d80bba4e..b6d709d3196 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/AbstractRangeBuilder.java @@ -49,6 +49,11 @@ import java.util.Map; import java.util.Objects; import java.util.function.Function; +/** + * Base Aggregation Builder for range aggs + * + * @opensearch.internal + */ public abstract class AbstractRangeBuilder, R extends Range> extends ValuesSourceAggregationBuilder< AB> { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregator.java index c4b4728db53..c846ba6c48b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregator.java @@ -55,7 +55,11 @@ import java.util.Map; import static java.util.Collections.emptyList; -/** A range aggregator for values that are stored in SORTED_SET doc values. */ +/** + * A range aggregator for values that are stored in SORTED_SET doc values. + * + * @opensearch.internal + */ public final class BinaryRangeAggregator extends BucketsAggregator { public static class Range { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregatorFactory.java index d1cadb9b9ec..0ee440ecc84 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/BinaryRangeAggregatorFactory.java @@ -46,6 +46,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregation Factory for binary_range + * + * @opensearch.internal + */ public class BinaryRangeAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregationBuilder.java index bf0d012be55..76b9370be46 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregationBuilder.java @@ -49,6 +49,11 @@ import java.io.IOException; import java.time.ZonedDateTime; import java.util.Map; +/** + * Aggregation Builder for date_range agg + * + * @opensearch.internal + */ public class DateRangeAggregationBuilder extends AbstractRangeBuilder { public static final String NAME = "date_range"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregatorFactory.java index c9d9eb39ff9..d243a89c632 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/DateRangeAggregatorFactory.java @@ -40,6 +40,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceConfig; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for date_range agg + * + * @opensearch.internal + */ public class DateRangeAggregatorFactory extends AbstractRangeAggregatorFactory { public DateRangeAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregationBuilder.java index 8e332cfd4a6..701f46719b8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregationBuilder.java @@ -65,6 +65,11 @@ import static org.opensearch.search.aggregations.bucket.range.RangeAggregator.Ra import static org.opensearch.search.aggregations.bucket.range.RangeAggregator.Range.KEY_FIELD; import static org.opensearch.search.aggregations.bucket.range.RangeAggregator.Range.TO_FIELD; +/** + * Aggregation Builder for geo_distance agg + * + * @opensearch.internal + */ public class GeoDistanceAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "geo_distance"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregatorSupplier.java index 430cbf4176c..c4a9efda18b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceAggregatorSupplier.java @@ -44,6 +44,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for geo_distance agg + * + * @opensearch.internal + */ public interface GeoDistanceAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceRangeAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceRangeAggregatorFactory.java index ba054357b4a..cd8179f00a8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceRangeAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/GeoDistanceRangeAggregatorFactory.java @@ -57,6 +57,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for geo_distance agg + * + * @opensearch.internal + */ public class GeoDistanceRangeAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalBinaryRange.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalBinaryRange.java index 506593113a0..95e04d3f47e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalBinaryRange.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalBinaryRange.java @@ -52,7 +52,11 @@ import java.util.stream.Collectors; import static java.util.Collections.unmodifiableList; -/** A range aggregation for data that is encoded in doc values using a binary representation. */ +/** + * A range aggregation for data that is encoded in doc values using a binary representation. + * + * @opensearch.internal + */ public final class InternalBinaryRange extends InternalMultiBucketAggregation implements Range { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalDateRange.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalDateRange.java index 6becf1f692c..8ce01370ad1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalDateRange.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalDateRange.java @@ -43,6 +43,11 @@ import java.time.ZoneOffset; import java.util.List; import java.util.Map; +/** + * Implementation of date range bucket + * + * @opensearch.internal + */ public class InternalDateRange extends InternalRange { public static final Factory FACTORY = new Factory(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalGeoDistance.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalGeoDistance.java index 6b3a19e1113..0cbe572e319 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalGeoDistance.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalGeoDistance.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Implementation of geo_distance bucket + * + * @opensearch.internal + */ public class InternalGeoDistance extends InternalRange { public static final Factory FACTORY = new Factory(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalRange.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalRange.java index ff61a0fd87e..8da0d132fd5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalRange.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/InternalRange.java @@ -49,6 +49,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of range bucket + * + * @opensearch.internal + */ public class InternalRange> extends InternalMultiBucketAggregation implements Range { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregationBuilder.java index 1a691a074a5..843733d736b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregationBuilder.java @@ -65,6 +65,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for ip_range agg + * + * @opensearch.internal + */ public final class IpRangeAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "ip_range"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregatorSupplier.java index e3de71a9b3c..5efe9d95291 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/IpRangeAggregatorSupplier.java @@ -43,6 +43,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregator supplier interface for ip_range agg + * + * @opensearch.internal + */ public interface IpRangeAggregatorSupplier { Aggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedBinaryRange.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedBinaryRange.java index 13f52759ea1..68f8aae9aef 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedBinaryRange.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedBinaryRange.java @@ -46,6 +46,11 @@ import java.util.List; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * A binary range agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedBinaryRange extends ParsedMultiBucketAggregation implements Range { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedDateRange.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedDateRange.java index a388fdd3d20..889b57b1a12 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedDateRange.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedDateRange.java @@ -40,6 +40,11 @@ import java.time.Instant; import java.time.ZoneOffset; import java.time.ZonedDateTime; +/** + * A date range agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedDateRange extends ParsedRange { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedGeoDistance.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedGeoDistance.java index 1877a951f38..86fa2555c72 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedGeoDistance.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedGeoDistance.java @@ -37,6 +37,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A geo distance range agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGeoDistance extends ParsedRange { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedRange.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedRange.java index ea7f4456bbd..0ad192636c0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedRange.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/ParsedRange.java @@ -48,6 +48,11 @@ import java.util.function.Supplier; import static org.opensearch.common.xcontent.XContentParserUtils.ensureExpectedToken; +/** + * A range agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedRange extends ParsedMultiBucketAggregation implements Range { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/Range.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/Range.java index 55619acf233..0a979a9a162 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/Range.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/Range.java @@ -38,6 +38,8 @@ import java.util.List; /** * A {@code range} aggregation. Defines multiple buckets, each associated with a pre-defined value range of a field, * and where the value of that fields in all documents in each bucket fall in the bucket's range. + * + * @opensearch.internal */ public interface Range extends MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregationBuilder.java index c50bcc1b614..649f4e6dbb7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregationBuilder.java @@ -47,6 +47,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceRegistry; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for range agg + * + * @opensearch.internal + */ public class RangeAggregationBuilder extends AbstractRangeBuilder { public static final String NAME = "range"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregator.java index 9786bc63405..4d2b0437adb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregator.java @@ -65,6 +65,11 @@ import java.util.Objects; import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; +/** + * Aggregate all docs that match given ranges. + * + * @opensearch.internal + */ public class RangeAggregator extends BucketsAggregator { public static final ParseField RANGES_FIELD = new ParseField("ranges"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorFactory.java index b2a1b1046aa..803bceaf57f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorFactory.java @@ -42,6 +42,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceConfig; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for range aggregators + * + * @opensearch.internal + */ public class RangeAggregatorFactory extends AbstractRangeAggregatorFactory { public RangeAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorSupplier.java index ecc6c6cde44..de9b979a561 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/range/RangeAggregatorSupplier.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base Aggregator supplier interface for range aggs + * + * @opensearch.internal + */ public interface RangeAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/BestDocsDeferringCollector.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/BestDocsDeferringCollector.java index 42ef44e642d..080142185f8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/BestDocsDeferringCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/BestDocsDeferringCollector.java @@ -64,6 +64,8 @@ import java.util.function.Consumer; * {@link BestDocsDeferringCollector#createTopDocsCollector(int)} is designed to * be overridden and allows subclasses to choose a custom collector * implementation for determining the top N matches. + * + * @opensearch.internal */ public class BestDocsDeferringCollector extends DeferringBucketCollector implements Releasable { private final List entries = new ArrayList<>(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregationBuilder.java index dc1ddddaa47..1fc31f8ffe0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregationBuilder.java @@ -51,6 +51,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for diversified_sampler agg + * + * @opensearch.internal + */ public class DiversifiedAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "diversified_sampler"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorFactory.java index f7b43a0da23..f8d3040620a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorFactory.java @@ -49,6 +49,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for diversified_sampler agg + * + * @opensearch.internal + */ public class DiversifiedAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorSupplier.java index 9992a18aa13..8f8b4f970ee 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedAggregatorSupplier.java @@ -40,6 +40,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base Aggregator supplier interface for diversified sampling aggs + * + * @opensearch.internal + */ public interface DiversifiedAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedBytesHashSamplerAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedBytesHashSamplerAggregator.java index c0b35368384..555e45460b8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedBytesHashSamplerAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedBytesHashSamplerAggregator.java @@ -55,6 +55,8 @@ import java.util.function.Consumer; /** * Alternative, faster implementation for converting String keys to longs but * with the potential for hash collisions. + * + * @opensearch.internal */ public class DiversifiedBytesHashSamplerAggregator extends SamplerAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedMapSamplerAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedMapSamplerAggregator.java index fdb00eed24c..cb880759887 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedMapSamplerAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedMapSamplerAggregator.java @@ -54,6 +54,11 @@ import java.io.IOException; import java.util.Map; import java.util.function.Consumer; +/** + * Aggregate all docs that match the diversified map sample + * + * @opensearch.internal + */ public class DiversifiedMapSamplerAggregator extends SamplerAggregator { private ValuesSource valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedNumericSamplerAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedNumericSamplerAggregator.java index 8b4bed89e67..472cc1beb82 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedNumericSamplerAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedNumericSamplerAggregator.java @@ -51,6 +51,11 @@ import java.io.IOException; import java.util.Map; import java.util.function.Consumer; +/** + * Aggregate all docs that match the diversified numeric sample + * + * @opensearch.internal + */ public class DiversifiedNumericSamplerAggregator extends SamplerAggregator { private ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedOrdinalsSamplerAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedOrdinalsSamplerAggregator.java index 62caa017edd..953a4597191 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedOrdinalsSamplerAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/DiversifiedOrdinalsSamplerAggregator.java @@ -52,6 +52,11 @@ import java.io.IOException; import java.util.Map; import java.util.function.Consumer; +/** + * Aggregate all docs that match the diversified ordinal sample + * + * @opensearch.internal + */ public class DiversifiedOrdinalsSamplerAggregator extends SamplerAggregator { private ValuesSource.Bytes.WithOrdinals.FieldData valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/InternalSampler.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/InternalSampler.java index 593c3c50ee1..8b6f4d32bed 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/InternalSampler.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/InternalSampler.java @@ -38,6 +38,11 @@ import org.opensearch.search.aggregations.bucket.InternalSingleBucketAggregation import java.io.IOException; import java.util.Map; +/** + * Implementation of sampler bucket + * + * @opensearch.internal + */ public class InternalSampler extends InternalSingleBucketAggregation implements Sampler { public static final String NAME = "mapped_sampler"; // InternalSampler and UnmappedSampler share the same parser name, so we use this when identifying the aggregation type diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/ParsedSampler.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/ParsedSampler.java index 6c4fe2927d7..005a6a40a46 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/ParsedSampler.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/ParsedSampler.java @@ -36,6 +36,11 @@ import org.opensearch.search.aggregations.bucket.ParsedSingleBucketAggregation; import java.io.IOException; +/** + * A sampler result parsed between nodes + * + * @opensearch.internal + */ public class ParsedSampler extends ParsedSingleBucketAggregation implements Sampler { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/Sampler.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/Sampler.java index 45fbf6913fd..a9c2a76a69b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/Sampler.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/Sampler.java @@ -37,5 +37,7 @@ import org.opensearch.search.aggregations.bucket.SingleBucketAggregation; * A {@code filter} aggregation that defines a single bucket to hold a sample of * top-matching documents. Computation of child aggregations is deferred until * the top-matching documents on a shard have been determined. + * + * @opensearch.internal */ public interface Sampler extends SingleBucketAggregation {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregationBuilder.java index 42aebe384f0..09c4ad0bb33 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregationBuilder.java @@ -47,6 +47,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for sampler agg + * + * @opensearch.internal + */ public class SamplerAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "sampler"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregator.java index a7855c2b400..fd1d7bf2997 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregator.java @@ -62,6 +62,8 @@ import java.util.Map; * as the basis for generating de-dup values. Their syntax for creating bucket * values would be preferable to users having to recreate this logic in a * 'script' e.g. to turn a datetime in milliseconds into a month key value. + * + * @opensearch.internal */ public class SamplerAggregator extends DeferableBucketAggregator implements SingleBucketAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregatorFactory.java index 35e3a618dfa..fa98c799352 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/SamplerAggregatorFactory.java @@ -42,6 +42,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for sampler agg + * + * @opensearch.internal + */ public class SamplerAggregatorFactory extends AggregatorFactory { private final int shardSize; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/UnmappedSampler.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/UnmappedSampler.java index 620a6e02c2b..a8abbb3e65d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/UnmappedSampler.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/sampler/UnmappedSampler.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Implementation of an unmapped sampler + * + * @opensearch.internal + */ public class UnmappedSampler extends InternalSampler { public static final String NAME = "unmapped_sampler"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractRareTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractRareTermsAggregator.java index 5820652b179..6ca66b38408 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractRareTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractRareTermsAggregator.java @@ -47,6 +47,11 @@ import java.io.IOException; import java.util.Map; import java.util.Random; +/** + * Base class to Aggregate all docs that contain rare terms + * + * @opensearch.internal + */ public abstract class AbstractRareTermsAggregator extends DeferableBucketAggregator { static final BucketOrder ORDER = BucketOrder.compound(BucketOrder.count(true), BucketOrder.key(true)); // sort by count ascending diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractStringTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractStringTermsAggregator.java index 9e838910672..9551be10e52 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractStringTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/AbstractStringTermsAggregator.java @@ -46,6 +46,11 @@ import java.util.Map; import static java.util.Collections.emptyList; +/** + * Base Aggregator to collect all docs that contain significant terms + * + * @opensearch.internal + */ abstract class AbstractStringTermsAggregator extends TermsAggregator { protected final boolean showTermDocCountError; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketPriorityQueue.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketPriorityQueue.java index 258a6c43c49..29314c08cfa 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketPriorityQueue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketPriorityQueue.java @@ -35,6 +35,11 @@ import org.apache.lucene.util.PriorityQueue; import java.util.Comparator; +/** + * Internal priority queue for computing terms aggs + * + * @opensearch.internal + */ public class BucketPriorityQueue extends PriorityQueue { private final Comparator comparator; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketSignificancePriorityQueue.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketSignificancePriorityQueue.java index 7a112135567..25e016fb77c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketSignificancePriorityQueue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BucketSignificancePriorityQueue.java @@ -34,6 +34,11 @@ package org.opensearch.search.aggregations.bucket.terms; import org.apache.lucene.util.PriorityQueue; +/** + * Priority queue for computing bucket significance + * + * @opensearch.internal + */ public class BucketSignificancePriorityQueue extends PriorityQueue { public BucketSignificancePriorityQueue(int size) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BytesKeyedBucketOrds.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BytesKeyedBucketOrds.java index 1cdf4f50953..7bfeff7615b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BytesKeyedBucketOrds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/BytesKeyedBucketOrds.java @@ -41,6 +41,8 @@ import org.opensearch.search.aggregations.CardinalityUpperBound; /** * Maps {@link BytesRef} bucket keys to bucket ordinals. + * + * @opensearch.internal */ public abstract class BytesKeyedBucketOrds implements Releasable { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/DoubleTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/DoubleTerms.java index c556dd1144b..7f276565778 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/DoubleTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/DoubleTerms.java @@ -47,6 +47,8 @@ import java.util.Objects; /** * Result of the {@link TermsAggregator} when the field is some kind of decimal number like a float, double, or distance. + * + * @opensearch.internal */ public class DoubleTerms extends InternalMappedTerms { public static final String NAME = "dterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/GlobalOrdinalsStringTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/GlobalOrdinalsStringTermsAggregator.java index 40b43d11c5b..4be90ac2f9b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/GlobalOrdinalsStringTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/GlobalOrdinalsStringTermsAggregator.java @@ -76,6 +76,8 @@ import static org.opensearch.search.aggregations.InternalOrder.isKeyOrder; /** * An aggregator of string values that relies on global ordinals in order to build buckets. + * + * @opensearch.internal */ public class GlobalOrdinalsStringTermsAggregator extends AbstractStringTermsAggregator { protected final ResultStrategy resultStrategy; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/IncludeExclude.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/IncludeExclude.java index f32abd18925..4464e4eb547 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/IncludeExclude.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/IncludeExclude.java @@ -68,6 +68,8 @@ import java.util.TreeSet; /** * Defines the include/exclude regular expression filtering for string terms aggregation. In this filtering logic, * exclusion has precedence, where the {@code include} is evaluated first and then the {@code exclude}. + * + * @opensearch.internal */ public class IncludeExclude implements Writeable, ToXContentFragment { public static final ParseField INCLUDE_FIELD = new ParseField("include"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedRareTerms.java index 7086fb4cba7..1d8e47b0d3e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedRareTerms.java @@ -53,6 +53,11 @@ import java.util.Objects; import java.util.function.Function; import java.util.stream.Collectors; +/** + * Implementation of mapped rare terms + * + * @opensearch.internal + */ public abstract class InternalMappedRareTerms, B extends InternalRareTerms.Bucket> extends InternalRareTerms { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedSignificantTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedSignificantTerms.java index ab47a220a65..d72162c81e0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedSignificantTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedSignificantTerms.java @@ -46,6 +46,11 @@ import java.util.Objects; import java.util.function.Function; import java.util.stream.Collectors; +/** + * Implementation of mapped significant terms + * + * @opensearch.internal + */ public abstract class InternalMappedSignificantTerms< A extends InternalMappedSignificantTerms, B extends InternalSignificantTerms.Bucket> extends InternalSignificantTerms { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedTerms.java index 5070b6e8fef..c38dd55fdfd 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMappedTerms.java @@ -47,6 +47,8 @@ import java.util.stream.Collectors; /** * Common superclass for results of the terms aggregation on mapped fields. + * + * @opensearch.internal */ public abstract class InternalMappedTerms, B extends InternalTerms.Bucket> extends InternalTerms { protected final DocValueFormat format; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java index fd1758d3ea8..f9207fb17a4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java @@ -30,6 +30,8 @@ import java.util.stream.Collectors; /** * Result of the {@link MultiTermsAggregator}. + * + * @opensearch.internal */ public class InternalMultiTerms extends InternalTerms { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalRareTerms.java index 8f51ede1bc2..441a0783536 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalRareTerms.java @@ -50,6 +50,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of rare terms + * + * @opensearch.internal + */ public abstract class InternalRareTerms, B extends InternalRareTerms.Bucket> extends InternalMultiBucketAggregation implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalSignificantTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalSignificantTerms.java index 4122e8b26e3..80fd4e2f5dc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalSignificantTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalSignificantTerms.java @@ -51,6 +51,8 @@ import java.util.Objects; /** * Result of the significant terms aggregation. + * + * @opensearch.internal */ public abstract class InternalSignificantTerms, B extends InternalSignificantTerms.Bucket> extends InternalMultiBucketAggregation diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalTerms.java index 8fae5720a90..a376d7fab90 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalTerms.java @@ -62,6 +62,11 @@ import java.util.function.Function; import static org.opensearch.search.aggregations.InternalOrder.isKeyAsc; import static org.opensearch.search.aggregations.InternalOrder.isKeyOrder; +/** + * Implementation of terms + * + * @opensearch.internal + */ public abstract class InternalTerms, B extends InternalTerms.AbstractInternalBucket> extends InternalMultiBucketAggregation implements diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongKeyedBucketOrds.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongKeyedBucketOrds.java index 0964d8aa8ad..d60c774adaa 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongKeyedBucketOrds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongKeyedBucketOrds.java @@ -40,6 +40,8 @@ import org.opensearch.search.aggregations.CardinalityUpperBound; /** * Maps long bucket keys to bucket ordinals. + * + * @opensearch.internal */ public abstract class LongKeyedBucketOrds implements Releasable { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTerms.java index f8ea5c4231c..f65401f913a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTerms.java @@ -46,6 +46,8 @@ import java.util.Objects; /** * Result of the RareTerms aggregation when the field is some kind of whole number like a integer, long, or a date. + * + * @opensearch.internal */ public class LongRareTerms extends InternalMappedRareTerms { public static final String NAME = "lrareterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTermsAggregator.java index 1a44c41c1f1..6e4cd895e74 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongRareTermsAggregator.java @@ -56,6 +56,8 @@ import static java.util.Collections.emptyList; /** * An aggregator that finds "rare" string values (e.g. terms agg that orders ascending) + * + * @opensearch.internal */ public class LongRareTermsAggregator extends AbstractRareTermsAggregator { private final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongTerms.java index 265fa532574..2a927499432 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/LongTerms.java @@ -47,6 +47,8 @@ import java.util.Objects; /** * Result of the {@link TermsAggregator} when the field is some kind of whole number like a integer, long, or a date. + * + * @opensearch.internal */ public class LongTerms extends InternalMappedTerms { public static final String NAME = "lterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MapStringTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MapStringTermsAggregator.java index a1c7d22bd29..2450a5a3692 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MapStringTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MapStringTermsAggregator.java @@ -68,6 +68,8 @@ import static org.opensearch.search.aggregations.InternalOrder.isKeyOrder; /** * An aggregator of string values that hashes the strings on the fly rather * than up front like the {@link GlobalOrdinalsStringTermsAggregator}. + * + * @opensearch.internal */ public class MapStringTermsAggregator extends AbstractStringTermsAggregator { private final CollectorSource collectorSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationBuilder.java index 78be4f980bc..cb2549a69b6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationBuilder.java @@ -102,6 +102,8 @@ import static org.opensearch.search.aggregations.bucket.terms.TermsAggregationBu * Notes: The current implementation focuses on adding new type aggregates. Performance (latency) is not good，mainly because of * simply encoding/decoding a list of values as bucket keys. *

+ * + * @opensearch.internal */ public class MultiTermsAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "multi_terms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java index d5600bc030b..695972564f7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java @@ -34,6 +34,8 @@ import static org.opensearch.search.aggregations.bucket.terms.MultiTermsAggregat /** * Factory of {@link MultiTermsAggregator}. + * + * @opensearch.internal */ public class MultiTermsAggregationFactory extends AggregatorFactory { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java index 36bf710f743..e5461ff7a03 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java @@ -51,6 +51,8 @@ import static org.opensearch.search.aggregations.bucket.terms.TermsAggregator.de /** * An aggregator that aggregate with multi_terms. + * + * @opensearch.internal */ public class MultiTermsAggregator extends DeferableBucketAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/NumericTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/NumericTermsAggregator.java index 4ea341caa0f..2c4c502b866 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/NumericTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/NumericTermsAggregator.java @@ -70,6 +70,11 @@ import java.util.function.Supplier; import static java.util.Collections.emptyList; import static org.opensearch.search.aggregations.InternalOrder.isKeyOrder; +/** + * Aggregate all docs that contain numeric terms + * + * @opensearch.internal + */ public class NumericTermsAggregator extends TermsAggregator { private final ResultStrategy resultStrategy; private final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedDoubleTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedDoubleTerms.java index 5be42312656..2ace6b637e6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedDoubleTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedDoubleTerms.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A double numeric terms result parsed between nodes + * + * @opensearch.internal + */ public class ParsedDoubleTerms extends ParsedTerms { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongRareTerms.java index e84c00519ac..c66f3cd6768 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongRareTerms.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A long numeric term result parsed between nodes + * + * @opensearch.internal + */ public class ParsedLongRareTerms extends ParsedRareTerms { @Override public String getType() { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongTerms.java index f75d1695819..45f51854aa6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedLongTerms.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A long term agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedLongTerms extends ParsedTerms { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java index 8686d329fa3..3e1c6f6533b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java @@ -15,6 +15,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; import java.util.List; +/** + * A multi terms result parsed between nodes + * + * @opensearch.internal + */ public class ParsedMultiTerms extends ParsedTerms { @Override public String getType() { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedRareTerms.java index a9fcd6e0277..f1950282449 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedRareTerms.java @@ -47,6 +47,11 @@ import java.util.ArrayList; import java.util.List; import java.util.function.Supplier; +/** + * A rare term result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedRareTerms extends ParsedMultiBucketAggregation implements RareTerms { @Override public List getBuckets() { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantLongTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantLongTerms.java index 1488588a684..23c29b2745f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantLongTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantLongTerms.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A significant long terms result parsed between nodes + * + * @opensearch.internal + */ public class ParsedSignificantLongTerms extends ParsedSignificantTerms { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantStringTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantStringTerms.java index 961e4881f1e..ce508687aed 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantStringTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantStringTerms.java @@ -40,6 +40,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; import java.nio.CharBuffer; +/** + * A significant string terms result parsed between nodes + * + * @opensearch.internal + */ public class ParsedSignificantStringTerms extends ParsedSignificantTerms { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantTerms.java index b57635a50d2..1d6b64f3dcd 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedSignificantTerms.java @@ -52,6 +52,11 @@ import java.util.Map; import java.util.function.Function; import java.util.stream.Collectors; +/** + * A significant terms result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedSignificantTerms extends ParsedMultiBucketAggregation implements SignificantTerms { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringRareTerms.java index 65a3090bee8..ecf5bd84097 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringRareTerms.java @@ -40,6 +40,11 @@ import org.opensearch.common.xcontent.ObjectParser; import org.opensearch.common.xcontent.XContentBuilder; import org.opensearch.common.xcontent.XContentParser; +/** + * A significant rare result parsed between nodes + * + * @opensearch.internal + */ public class ParsedStringRareTerms extends ParsedRareTerms { @Override public String getType() { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringTerms.java index faf34c6da5f..c849d6c8c88 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedStringTerms.java @@ -40,6 +40,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; import java.nio.CharBuffer; +/** + * A string result parsed between nodes + * + * @opensearch.internal + */ public class ParsedStringTerms extends ParsedTerms { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedTerms.java index 054ea7d8270..68de52a2531 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedTerms.java @@ -50,6 +50,11 @@ import java.util.function.Supplier; import static org.opensearch.search.aggregations.bucket.terms.InternalTerms.DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME; import static org.opensearch.search.aggregations.bucket.terms.InternalTerms.SUM_OF_OTHER_DOC_COUNTS; +/** + * A terms result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedTerms extends ParsedMultiBucketAggregation implements Terms { protected long docCountErrorUpperBound; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTerms.java index 4e9c9be2cd2..6e26503c149 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTerms.java @@ -35,6 +35,11 @@ import org.opensearch.search.aggregations.bucket.MultiBucketsAggregation; import java.util.List; +/** + * Rare terms interface + * + * @opensearch.internal + */ public interface RareTerms extends MultiBucketsAggregation { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregationBuilder.java index 2b419d1a452..64436e1b2fb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregationBuilder.java @@ -52,6 +52,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for rare_terms agg + * + * @opensearch.internal + */ public class RareTermsAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "rare_terms"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorFactory.java index ed70a9b310e..b689865ac8c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorFactory.java @@ -53,6 +53,11 @@ import java.io.IOException; import java.util.Arrays; import java.util.Map; +/** + * Aggregation Factory for rare_terms agg + * + * @opensearch.internal + */ public class RareTermsAggregatorFactory extends ValuesSourceAggregatorFactory { private final IncludeExclude includeExclude; private final int maxDocCount; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorSupplier.java index 7fe05adc7c6..5f8888e2819 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/RareTermsAggregatorSupplier.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for rare_terms agg + * + * @opensearch.internal + */ interface RareTermsAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificanceLookup.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificanceLookup.java index 39113525683..aee4caa67af 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificanceLookup.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificanceLookup.java @@ -60,6 +60,8 @@ import java.io.IOException; /** * Looks up values used for {@link SignificanceHeuristic}s. + * + * @opensearch.internal */ class SignificanceLookup { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantLongTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantLongTerms.java index 1aebdc66373..6e2b48f5579 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantLongTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantLongTerms.java @@ -45,6 +45,8 @@ import java.util.Objects; /** * Result of the running the significant terms aggregation on a numeric field. + * + * @opensearch.internal */ public class SignificantLongTerms extends InternalMappedSignificantTerms { public static final String NAME = "siglterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantStringTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantStringTerms.java index 9c0f075ea5b..3795df964b0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantStringTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantStringTerms.java @@ -46,6 +46,8 @@ import java.util.Objects; /** * Result of the running the significant terms aggregation on a String field. + * + * @opensearch.internal */ public class SignificantStringTerms extends InternalMappedSignificantTerms { public static final String NAME = "sigsterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTerms.java index 299a6d29f1b..a5d1c29b0ee 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTerms.java @@ -37,6 +37,8 @@ import java.util.List; /** * An aggregation that collects significant terms in comparison to a background set. + * + * @opensearch.internal */ public interface SignificantTerms extends MultiBucketsAggregation, Iterable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregationBuilder.java index 3c9c5797fff..c50436b6223 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregationBuilder.java @@ -60,6 +60,11 @@ import java.util.Objects; import static org.opensearch.index.query.AbstractQueryBuilder.parseInnerQueryBuilder; +/** + * Aggregation Builder for significant terms agg + * + * @opensearch.internal + */ public class SignificantTermsAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "significant_terms"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorFactory.java index 8935c9715a1..ff35d128ef5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorFactory.java @@ -58,6 +58,11 @@ import java.io.IOException; import java.util.Arrays; import java.util.Map; +/** + * Aggregation Factory for significant_terms agg + * + * @opensearch.internal + */ public class SignificantTermsAggregatorFactory extends ValuesSourceAggregatorFactory { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(SignificantTermsAggregatorFactory.class); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorSupplier.java index 2d07527d61e..a1fa7ab9d06 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTermsAggregatorSupplier.java @@ -42,6 +42,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for significant_terms agg + * + * @opensearch.internal + */ interface SignificantTermsAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregationBuilder.java index bdfcf0e27fa..7be04b13f0d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregationBuilder.java @@ -55,6 +55,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for significant text agg + * + * @opensearch.internal + */ public class SignificantTextAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "significant_text"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregatorFactory.java index 9085df1ccd7..a509cbfd49f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/SignificantTextAggregatorFactory.java @@ -68,6 +68,11 @@ import java.util.Iterator; import java.util.Map; import java.util.function.LongConsumer; +/** + * Aggregation Factory for significant_text agg + * + * @opensearch.internal + */ public class SignificantTextAggregatorFactory extends AggregatorFactory { private static final int MEMORY_GROWTH_REPORTING_INTERVAL_BYTES = 5000; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTerms.java index 58473c71556..f6a925c5340 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTerms.java @@ -45,6 +45,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of string rare terms + * + * @opensearch.internal + */ public class StringRareTerms extends InternalMappedRareTerms { public static final String NAME = "srareterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTermsAggregator.java index b4093a73f73..c796faa6a8b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringRareTermsAggregator.java @@ -58,6 +58,8 @@ import static java.util.Collections.emptyList; /** * An aggregator that finds "rare" string values (e.g. terms agg that orders ascending) + * + * @opensearch.internal */ public class StringRareTermsAggregator extends AbstractRareTermsAggregator { private final ValuesSource.Bytes valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringTerms.java index 3e70428472c..829ec07c910 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/StringTerms.java @@ -46,6 +46,8 @@ import java.util.Objects; /** * Result of the {@link TermsAggregator} when the field is a String. + * + * @opensearch.internal */ public class StringTerms extends InternalMappedTerms { public static final String NAME = "sterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/Terms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/Terms.java index e6cb64928c0..df2028c81b1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/Terms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/Terms.java @@ -38,6 +38,8 @@ import java.util.List; /** * A {@code terms} aggregation. Defines multiple bucket, each associated with a unique term for a specific field. * All documents in a bucket has the bucket's term in that field. + * + * @opensearch.internal */ public interface Terms extends MultiBucketsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregationBuilder.java index 11a51f51d53..ae1c2bff2c3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregationBuilder.java @@ -60,6 +60,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for terms agg + * + * @opensearch.internal + */ public class TermsAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "terms"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregator.java index a5ee44ffa22..d60d1609ae9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregator.java @@ -56,6 +56,11 @@ import java.util.Map; import java.util.Objects; import java.util.Set; +/** + * Base aggregator class to aggregate documents by terms + * + * @opensearch.internal + */ public abstract class TermsAggregator extends DeferableBucketAggregator { public static class BucketCountThresholds implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorFactory.java index b320126dff2..abbd7945bdd 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorFactory.java @@ -62,6 +62,11 @@ import java.util.Arrays; import java.util.Map; import java.util.function.Function; +/** + * Aggregation Factory for terms agg + * + * @opensearch.internal + */ public class TermsAggregatorFactory extends ValuesSourceAggregatorFactory { static Boolean REMAP_GLOBAL_ORDS, COLLECT_SEGMENT_ORDS; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorSupplier.java index a9b31937893..27e5adf0314 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/TermsAggregatorSupplier.java @@ -42,6 +42,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for terms agg + * + * @opensearch.internal + */ interface TermsAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedRareTerms.java index ef759cf4e74..279bbf95641 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedRareTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedRareTerms.java @@ -48,6 +48,8 @@ import static java.util.Collections.emptyList; /** * Result of the RareTerms aggregation when the field is unmapped. + * + * @opensearch.internal */ public class UnmappedRareTerms extends InternalRareTerms { public static final String NAME = "umrareterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedSignificantTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedSignificantTerms.java index a99f013327a..535a6b58059 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedSignificantTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedSignificantTerms.java @@ -50,6 +50,8 @@ import static java.util.Collections.emptyList; /** * Result of the running the significant terms aggregation on an unmapped field. + * + * @opensearch.internal */ public class UnmappedSignificantTerms extends InternalSignificantTerms { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedTerms.java index ad499aed451..9b792720b49 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/UnmappedTerms.java @@ -48,6 +48,8 @@ import static java.util.Collections.emptyList; /** * Result of the {@link TermsAggregator} when the field is unmapped. + * + * @opensearch.internal */ public class UnmappedTerms extends InternalTerms { public static final String NAME = "umterms"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ChiSquare.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ChiSquare.java index 3083fa2b868..1597976986b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ChiSquare.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ChiSquare.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; +/** + * ChiSquare significance heuristic for significant terms agg + * + * @opensearch.internal + */ public class ChiSquare extends NXYSignificanceHeuristic { public static final String NAME = "chi_square"; public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/GND.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/GND.java index 4e88ad992bd..4f315836d9b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/GND.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/GND.java @@ -41,6 +41,11 @@ import java.io.IOException; import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; +/** + * GND significance heuristic for significant terms agg + * + * @opensearch.internal + */ public class GND extends NXYSignificanceHeuristic { public static final String NAME = "gnd"; public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>(NAME, args -> { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/JLHScore.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/JLHScore.java index b3cc463f71e..1b36947f72d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/JLHScore.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/JLHScore.java @@ -39,6 +39,11 @@ import org.opensearch.common.io.stream.StreamOutput; import org.opensearch.common.xcontent.ObjectParser; import org.opensearch.common.xcontent.XContentBuilder; +/** + * JLHScore heuristic for significant terms agg + * + * @opensearch.internal + */ public class JLHScore extends SignificanceHeuristic { public static final String NAME = "jlh"; public static final ObjectParser PARSER = new ObjectParser<>(NAME, JLHScore::new); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/MutualInformation.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/MutualInformation.java index 3114aa940f2..761e1cf31da 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/MutualInformation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/MutualInformation.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; +/** + * Mutual Information significance heuristic for significant terms agg + * + * @opensearch.internal + */ public class MutualInformation extends NXYSignificanceHeuristic { public static final String NAME = "mutual_information"; public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/NXYSignificanceHeuristic.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/NXYSignificanceHeuristic.java index a194765209a..e385bea5a7c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/NXYSignificanceHeuristic.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/NXYSignificanceHeuristic.java @@ -44,6 +44,11 @@ import java.util.function.Function; import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; +/** + * NXY significance heuristic for significant terms agg + * + * @opensearch.internal + */ public abstract class NXYSignificanceHeuristic extends SignificanceHeuristic { protected static final ParseField BACKGROUND_IS_SUPERSET = new ParseField("background_is_superset"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/PercentageScore.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/PercentageScore.java index fa80ba67a7b..5e976d0fd67 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/PercentageScore.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/PercentageScore.java @@ -42,6 +42,11 @@ import org.opensearch.index.query.QueryShardException; import java.io.IOException; +/** + * Percentage score significance heuristic for significant terms agg + * + * @opensearch.internal + */ public class PercentageScore extends SignificanceHeuristic { public static final String NAME = "percentage"; public static final ObjectParser PARSER = new ObjectParser<>(NAME, PercentageScore::new); diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ScriptHeuristic.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ScriptHeuristic.java index eeebdabda45..65f3ec4bd75 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ScriptHeuristic.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/ScriptHeuristic.java @@ -48,6 +48,11 @@ import java.util.Objects; import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; +/** + * Script significance heuristic for significant terms agg + * + * @opensearch.internal + */ public class ScriptHeuristic extends SignificanceHeuristic { public static final String NAME = "script_heuristic"; public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristic.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristic.java index b63cc483e58..7644c84bf22 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristic.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristic.java @@ -40,6 +40,8 @@ import org.opensearch.search.aggregations.bucket.terms.SignificantTerms; /** * Heuristic for that {@link SignificantTerms} uses to pick out significant terms. + * + * @opensearch.internal */ public abstract class SignificanceHeuristic implements NamedWriteable, ToXContentFragment { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristicBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristicBuilder.java index b824652bdbe..576247b0989 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristicBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/heuristic/SignificanceHeuristicBuilder.java @@ -34,4 +34,9 @@ package org.opensearch.search.aggregations.bucket.terms.heuristic; import org.opensearch.common.xcontent.ToXContentFragment; +/** + * Base builder class for significance heuristics + * + * @opensearch.internal + */ public interface SignificanceHeuristicBuilder extends ToXContentFragment {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractCardinalityAlgorithm.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractCardinalityAlgorithm.java index 8851313f61e..a8a7b513d01 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractCardinalityAlgorithm.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractCardinalityAlgorithm.java @@ -34,6 +34,8 @@ package org.opensearch.search.aggregations.metrics; /** * Base class for cardinality related algorithms. + * + * @opensearch.internal */ abstract class AbstractCardinalityAlgorithm { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHDRPercentilesAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHDRPercentilesAggregator.java index abf63ee0b73..a0d86b382ee 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHDRPercentilesAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHDRPercentilesAggregator.java @@ -50,6 +50,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base aggregator for HDR percentiles agg + * + * @opensearch.internal + */ abstract class AbstractHDRPercentilesAggregator extends NumericMetricsAggregator.MultiValue { private static int indexOfKey(double[] keys, double key) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLog.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLog.java index 8008d70f664..89b77eb840d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLog.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLog.java @@ -38,6 +38,8 @@ package org.opensearch.search.aggregations.metrics; * https://docs.google.com/document/d/1gyjfMHy43U9OWBXxfaeG-3MjGzejW1dlpyMwEYAAWEI/view?fullscreen * * Trying to understand what this class does without having read the paper is considered adventurous. + * + * @opensearch.internal */ public abstract class AbstractHyperLogLog extends AbstractCardinalityAlgorithm { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLogPlusPlus.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLogPlusPlus.java index 75d9dea7ef8..4ea9c48e360 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLogPlusPlus.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractHyperLogLogPlusPlus.java @@ -48,6 +48,8 @@ import java.util.Set; * Base class for HLL++ algorithms. * * It contains methods for cloning and serializing the data structure. + * + * @opensearch.internal */ public abstract class AbstractHyperLogLogPlusPlus extends AbstractCardinalityAlgorithm implements Releasable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalHDRPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalHDRPercentiles.java index 0dc2803d5f6..568305cf6ff 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalHDRPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalHDRPercentiles.java @@ -47,6 +47,11 @@ import java.util.Map; import java.util.Objects; import java.util.zip.DataFormatException; +/** + * Base implementation of HDR percentiles + * + * @opensearch.internal + */ abstract class AbstractInternalHDRPercentiles extends InternalNumericMetricsAggregation.MultiValue { protected final double[] keys; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalTDigestPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalTDigestPercentiles.java index 5ac87df3e13..5b881da8041 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalTDigestPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractInternalTDigestPercentiles.java @@ -44,6 +44,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Base implementation of TDigest percentiles + * + * @opensearch.internal + */ abstract class AbstractInternalTDigestPercentiles extends InternalNumericMetricsAggregation.MultiValue { protected final double[] keys; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractLinearCounting.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractLinearCounting.java index 71a97e1456f..3b607b3a867 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractLinearCounting.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractLinearCounting.java @@ -42,6 +42,8 @@ import org.apache.lucene.util.packed.PackedInts; * Trying to understand what this class does without having read the paper is considered adventurous. * * The algorithm just keep a record of all distinct values provided encoded as an integer. + * + * @opensearch.internal */ public abstract class AbstractLinearCounting extends AbstractCardinalityAlgorithm { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractPercentilesAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractPercentilesAggregationBuilder.java index ac0baf18dfb..a580d17099e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractPercentilesAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractPercentilesAggregationBuilder.java @@ -55,6 +55,8 @@ import java.util.function.Supplier; * This provides a base class for aggregations that are building percentiles or percentiles-like functionality (e.g. percentile ranks). * It provides a set of common fields/functionality for setting the available algorithms (TDigest and HDRHistogram), * as well as algorithm-specific settings via a {@link PercentilesConfig} object + * + * @opensearch.internal */ public abstract class AbstractPercentilesAggregationBuilder> extends ValuesSourceAggregationBuilder.LeafOnly { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractTDigestPercentilesAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractTDigestPercentilesAggregator.java index 80bfcb55f73..8c79a80a26b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractTDigestPercentilesAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractTDigestPercentilesAggregator.java @@ -49,6 +49,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base aggregator for the TDigest agg + * + * @opensearch.internal + */ abstract class AbstractTDigestPercentilesAggregator extends NumericMetricsAggregator.MultiValue { private static int indexOfKey(double[] keys, double key) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Avg.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Avg.java index 0c662423b24..4deffd60f28 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Avg.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Avg.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes the average of the values in the current bucket. + * + * @opensearch.internal */ public interface Avg extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregationBuilder.java index 8fd3febc4d2..96a131117c3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregationBuilder.java @@ -50,6 +50,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for avg agg + * + * @opensearch.internal + */ public class AvgAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "avg"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregator.java index 24cebdf2897..e58466b56df 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregator.java @@ -50,6 +50,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into an average + * + * @opensearch.internal + */ class AvgAggregator extends NumericMetricsAggregator.SingleValue { final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregatorFactory.java index 696d65ec9d8..727304f8a52 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/AvgAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for avg agg + * + * @opensearch.internal + */ class AvgAggregatorFactory extends ValuesSourceAggregatorFactory { AvgAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Cardinality.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Cardinality.java index 749c2554cf4..dab281aa7ec 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Cardinality.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Cardinality.java @@ -34,6 +34,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes approximate numbers of unique terms. + * + * @opensearch.internal */ public interface Cardinality extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregationBuilder.java index 12771f06e31..8cb5e80597a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregationBuilder.java @@ -53,6 +53,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for cardinality agg + * + * @opensearch.internal + */ public final class CardinalityAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly< ValuesSource, CardinalityAggregationBuilder> { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregator.java index 61cb08ba28a..1c1530843a6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregator.java @@ -63,6 +63,8 @@ import java.util.function.BiConsumer; /** * An aggregator that computes approximate counts of unique values. + * + * @opensearch.internal */ public class CardinalityAggregator extends NumericMetricsAggregator.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorFactory.java index 944cc4dc907..47084436d3d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for cardinality agg + * + * @opensearch.internal + */ class CardinalityAggregatorFactory extends ValuesSourceAggregatorFactory { private final Long precisionThreshold; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorSupplier.java index 8ecd0fba915..d5cb0242762 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/CardinalityAggregatorSupplier.java @@ -39,6 +39,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for cardinality agg + * + * @opensearch.internal + */ public interface CardinalityAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/CompensatedSum.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/CompensatedSum.java index 0cf637885cf..151b0d50739 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/CompensatedSum.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/CompensatedSum.java @@ -40,6 +40,8 @@ package org.opensearch.search.aggregations.metrics; * truncation and rounding. These errors can lead to numerical instability. * * @see Kahan Summation Algorithm + * + * @opensearch.internal */ public class CompensatedSum { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStats.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStats.java index ed8ffc1e19e..36e9c1f9386 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStats.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStats.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * Statistics over a set of values (either aggregated over field data or scripts) + * + * @opensearch.internal */ public interface ExtendedStats extends Stats { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregationBuilder.java index cc01cba7c2a..649650b5a8d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregationBuilder.java @@ -51,6 +51,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for extended stats agg + * + * @opensearch.internal + */ public class ExtendedStatsAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly< ValuesSource.Numeric, ExtendedStatsAggregationBuilder> { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregator.java index b973f2cb742..203fcd30b63 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregator.java @@ -51,6 +51,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into their extended statistics + * + * @opensearch.internal + */ class ExtendedStatsAggregator extends NumericMetricsAggregator.MultiValue { static final ParseField SIGMA_FIELD = new ParseField("sigma"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorFactory.java index f08d9630e86..20203b22b24 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorFactory.java @@ -47,6 +47,11 @@ import java.io.IOException; import java.util.Arrays; import java.util.Map; +/** + * Aggregation Factory for extended_stats agg + * + * @opensearch.internal + */ class ExtendedStatsAggregatorFactory extends ValuesSourceAggregatorFactory { private final double sigma; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorProvider.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorProvider.java index ac86ebc2fc8..88cdf60b7ae 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorProvider.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ExtendedStatsAggregatorProvider.java @@ -38,6 +38,9 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base supplier of an ExtendesStats aggregator + */ public interface ExtendedStatsAggregatorProvider { Aggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBounds.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBounds.java index ba0e115c383..380fbce85ad 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBounds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBounds.java @@ -37,6 +37,8 @@ import org.opensearch.search.aggregations.Aggregation; /** * An aggregation that computes a bounding box in which all documents of the current bucket are. + * + * @opensearch.internal */ public interface GeoBounds extends Aggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregationBuilder.java index 30ba6988325..64e27fa7e13 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregationBuilder.java @@ -50,6 +50,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for geo_bounds agg + * + * @opensearch.internal + */ public class GeoBoundsAggregationBuilder extends ValuesSourceAggregationBuilder { public static final String NAME = "geo_bounds"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregator.java index 6d3b0796ac5..054e8d4cb1c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregator.java @@ -50,6 +50,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a geographic bounds + * + * @opensearch.internal + */ final class GeoBoundsAggregator extends MetricsAggregator { static final ParseField WRAP_LONGITUDE_FIELD = new ParseField("wrap_longitude"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorFactory.java index 27744a549c7..2c6b75842b6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for geo_bounds agg + * + * @opensearch.internal + */ class GeoBoundsAggregatorFactory extends ValuesSourceAggregatorFactory { private final boolean wrapLongitude; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorSupplier.java index 38e2fc919cf..4fd2b7be494 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoBoundsAggregatorSupplier.java @@ -39,6 +39,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for geo_bounds agg + * + * @opensearch.internal + */ @FunctionalInterface public interface GeoBoundsAggregatorSupplier { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroid.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroid.java index 69f835e54ff..a5c13d15bac 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroid.java @@ -37,6 +37,8 @@ import org.opensearch.search.aggregations.Aggregation; /** * Interface for {@link GeoCentroidAggregator} + * + * @opensearch.internal */ public interface GeoCentroid extends Aggregation { GeoPoint centroid(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregationBuilder.java index dff3950fbe9..b8c0b9ad1b2 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregationBuilder.java @@ -50,6 +50,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for geo_centroid agg + * + * @opensearch.internal + */ public class GeoCentroidAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly< ValuesSource.GeoPoint, GeoCentroidAggregationBuilder> { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregator.java index a8e8907b61c..65621160843 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregator.java @@ -52,6 +52,8 @@ import java.util.Map; /** * A geo metric aggregator that computes a geo-centroid from a {@code geo_point} type field + * + * @opensearch.internal */ final class GeoCentroidAggregator extends MetricsAggregator { private final ValuesSource.GeoPoint valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregatorFactory.java index d8ad21d5325..1d450eeae98 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoCentroidAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for geo_centroid agg + * + * @opensearch.internal + */ class GeoCentroidAggregatorFactory extends ValuesSourceAggregatorFactory { GeoCentroidAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoGridAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoGridAggregatorSupplier.java index 3c29c3558eb..183c64f4e4a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoGridAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/GeoGridAggregatorSupplier.java @@ -43,6 +43,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base Aggregator supplier interface for geo grid aggs + * + * @opensearch.internal + */ @FunctionalInterface public interface GeoGridAggregatorSupplier { GeoGridAggregator build( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentileRanksAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentileRanksAggregator.java index 959f0f82da4..8dea6c3a4b6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentileRanksAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentileRanksAggregator.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into an HDR percentile ranks values + * + * @opensearch.internal + */ class HDRPercentileRanksAggregator extends AbstractHDRPercentilesAggregator { HDRPercentileRanksAggregator( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentilesAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentilesAggregator.java index 83c6cf051cb..e8b1e73db68 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentilesAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/HDRPercentilesAggregator.java @@ -41,6 +41,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a single HDR percentile + * + * @opensearch.internal + */ class HDRPercentilesAggregator extends AbstractHDRPercentilesAggregator { HDRPercentilesAggregator( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlus.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlus.java index 3408e8cf3bb..bfc121627bf 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlus.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlus.java @@ -60,6 +60,8 @@ import java.nio.ByteOrder; * to the HyperLogLog algorithm and then this is used. * * It supports storing several HyperLogLogPlusPlus structures which are identified by a bucket number. + * + * @opensearch.internal */ public final class HyperLogLogPlusPlus extends AbstractHyperLogLogPlusPlus { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlusSparse.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlusSparse.java index 1a7a544d26b..9a042726423 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlusSparse.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/HyperLogLogPlusPlusSparse.java @@ -43,6 +43,8 @@ import org.opensearch.common.util.IntArray; * * This structure expects all the added values to be distinct and therefore there are no checks * if an element has been previously added. + * + * @opensearch.internal */ final class HyperLogLogPlusPlusSparse extends AbstractHyperLogLogPlusPlus implements Releasable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalAvg.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalAvg.java index ddbae8b37b3..0dff1c7a9c2 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalAvg.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalAvg.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of internal agg + * + * @opensearch.internal + */ public class InternalAvg extends InternalNumericMetricsAggregation.SingleValue implements Avg { private final double sum; private final long count; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalCardinality.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalCardinality.java index 234e20393fa..b4105084560 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalCardinality.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalCardinality.java @@ -44,6 +44,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of cardinality agg + * + * @opensearch.internal + */ public final class InternalCardinality extends InternalNumericMetricsAggregation.SingleValue implements Cardinality { private final AbstractHyperLogLogPlusPlus counts; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalExtendedStats.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalExtendedStats.java index 34d87d92dbb..75a4dbb4e74 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalExtendedStats.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalExtendedStats.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of extended stats agg + * + * @opensearch.internal + */ public class InternalExtendedStats extends InternalStats implements ExtendedStats { enum Metrics { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoBounds.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoBounds.java index 84a46ed6c71..87018242ee8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoBounds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoBounds.java @@ -44,6 +44,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of geo bounds agg + * + * @opensearch.internal + */ public class InternalGeoBounds extends InternalAggregation implements GeoBounds { public final double top; public final double bottom; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoCentroid.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoCentroid.java index c043cca5d6c..262f8cc8901 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoCentroid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalGeoCentroid.java @@ -48,6 +48,8 @@ import java.util.Objects; /** * Serialization and merge logic for {@link GeoCentroidAggregator}. + * + * @opensearch.internal */ public class InternalGeoCentroid extends InternalAggregation implements GeoCentroid { private final GeoPoint centroid; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentileRanks.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentileRanks.java index eb11d4bda33..ba3c917d1b5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentileRanks.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentileRanks.java @@ -39,6 +39,11 @@ import java.io.IOException; import java.util.Iterator; import java.util.Map; +/** + * Implementation of HDR percentiles ranks + * + * @opensearch.internal + */ public class InternalHDRPercentileRanks extends AbstractInternalHDRPercentiles implements PercentileRanks { public static final String NAME = "hdr_percentile_ranks"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentiles.java index 2ba910fee43..2b1da638749 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalHDRPercentiles.java @@ -39,6 +39,11 @@ import java.io.IOException; import java.util.Iterator; import java.util.Map; +/** + * Implementation of HDR percentiles agg + * + * @opensearch.internal + */ public class InternalHDRPercentiles extends AbstractInternalHDRPercentiles implements Percentiles { public static final String NAME = "hdr_percentiles"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMax.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMax.java index 675f82eda8a..6c9dcb29e23 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMax.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMax.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of max agg + * + * @opensearch.internal + */ public class InternalMax extends InternalNumericMetricsAggregation.SingleValue implements Max { private final double max; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMedianAbsoluteDeviation.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMedianAbsoluteDeviation.java index 9066709b8bf..864894f7547 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMedianAbsoluteDeviation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMedianAbsoluteDeviation.java @@ -43,6 +43,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of median absolute deviation agg + * + * @opensearch.internal + */ public class InternalMedianAbsoluteDeviation extends InternalNumericMetricsAggregation.SingleValue implements MedianAbsoluteDeviation { static double computeMedianAbsoluteDeviation(TDigestState valuesSketch) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMin.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMin.java index ba00bc457ff..8f28a714ba8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMin.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalMin.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of min agg + * + * @opensearch.internal + */ public class InternalMin extends InternalNumericMetricsAggregation.SingleValue implements Min { private final double min; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalNumericMetricsAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalNumericMetricsAggregation.java index e7c43794d39..2c66321ecb3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalNumericMetricsAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalNumericMetricsAggregation.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Base aggregation to aggregate all docs into a single numeric metric + * + * @opensearch.internal + */ public abstract class InternalNumericMetricsAggregation extends InternalAggregation { private static final DocValueFormat DEFAULT_FORMAT = DocValueFormat.RAW; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalScriptedMetric.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalScriptedMetric.java index a9924916de1..9244d661a69 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalScriptedMetric.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalScriptedMetric.java @@ -51,6 +51,11 @@ import java.util.Objects; import static java.util.Collections.singletonList; +/** + * Implementation of scripted metric agg + * + * @opensearch.internal + */ public class InternalScriptedMetric extends InternalAggregation implements ScriptedMetric { final Script reduceScript; private final List aggregations; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalStats.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalStats.java index 6c6953633c7..6bd48f22134 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalStats.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalStats.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of stats agg + * + * @opensearch.internal + */ public class InternalStats extends InternalNumericMetricsAggregation.MultiValue implements Stats { enum Metrics { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalSum.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalSum.java index 174b6978396..0a89b5ed3d1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalSum.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalSum.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of sum agg + * + * @opensearch.internal + */ public class InternalSum extends InternalNumericMetricsAggregation.SingleValue implements Sum { private final double sum; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentileRanks.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentileRanks.java index 65d3ece0bbb..45ce6dc3ead 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentileRanks.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentileRanks.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.util.Iterator; import java.util.Map; +/** + * Implementation of TDigest percentiles rank agg + * + * @opensearch.internal + */ public class InternalTDigestPercentileRanks extends AbstractInternalTDigestPercentiles implements PercentileRanks { public static final String NAME = "tdigest_percentile_ranks"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentiles.java index 1988d03ca5e..8cc224f2f08 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTDigestPercentiles.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.util.Iterator; import java.util.Map; +/** + * Implementation of TDigest percentiles agg + * + * @opensearch.internal + */ public class InternalTDigestPercentiles extends AbstractInternalTDigestPercentiles implements Percentiles { public static final String NAME = "tdigest_percentiles"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTopHits.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTopHits.java index 24e7875a6ad..0f17c6c9180 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTopHits.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalTopHits.java @@ -53,6 +53,8 @@ import java.util.Map; /** * Results of the {@link TopHitsAggregator}. + * + * @opensearch.internal */ public class InternalTopHits extends InternalAggregation implements TopHits { private int from; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalValueCount.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalValueCount.java index 7e839a6874e..0f7aff1a674 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalValueCount.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalValueCount.java @@ -43,6 +43,8 @@ import java.util.Objects; /** * An internal implementation of {@link ValueCount}. + * + * @opensearch.internal */ public class InternalValueCount extends InternalNumericMetricsAggregation.SingleValue implements ValueCount { private final long value; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalWeightedAvg.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalWeightedAvg.java index 6e2cf0dc6d3..b2855f8bd15 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalWeightedAvg.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/InternalWeightedAvg.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of weighted avg agg + * + * @opensearch.internal + */ public class InternalWeightedAvg extends InternalNumericMetricsAggregation.SingleValue implements WeightedAvg { private final double sum; private final double weight; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Max.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Max.java index 24a0c834b59..5834173e10e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Max.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Max.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes the maximum of the values in the current bucket. + * + * @opensearch.internal */ public interface Max extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregationBuilder.java index 4cdc73a08dd..55c5a6ca3ce 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregationBuilder.java @@ -50,6 +50,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for max agg + * + * @opensearch.internal + */ public class MaxAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "max"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregator.java index b755d54de0f..8108b8a7268 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregator.java @@ -57,6 +57,11 @@ import java.util.Arrays; import java.util.Map; import java.util.function.Function; +/** + * Aggregate all docs into a max value + * + * @opensearch.internal + */ class MaxAggregator extends NumericMetricsAggregator.SingleValue { final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregatorFactory.java index 2541f8fdf0b..3ec24ad04d9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MaxAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for max agg + * + * @opensearch.internal + */ class MaxAggregatorFactory extends ValuesSourceAggregatorFactory { static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviation.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviation.java index 34437b7c916..0c989f62730 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviation.java @@ -36,6 +36,8 @@ package org.opensearch.search.aggregations.metrics; * An aggregation that approximates the median absolute deviation of a numeric field * * @see https://en.wikipedia.org/wiki/Median_absolute_deviation + * + * @opensearch.internal */ public interface MedianAbsoluteDeviation extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregationBuilder.java index 09faa958f82..e6a8de6b4ed 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregationBuilder.java @@ -54,6 +54,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for median_absolute_deviation agg + * + * @opensearch.internal + */ public class MedianAbsoluteDeviationAggregationBuilder extends LeafOnly { public static final String NAME = "median_absolute_deviation"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregator.java index 24c26d695c7..0b4684452a8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregator.java @@ -53,6 +53,11 @@ import java.util.Objects; import static org.opensearch.search.aggregations.metrics.InternalMedianAbsoluteDeviation.computeMedianAbsoluteDeviation; +/** + * Aggregate all docs into a median absolute deviation + * + * @opensearch.internal + */ public class MedianAbsoluteDeviationAggregator extends NumericMetricsAggregator.SingleValue { private final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorFactory.java index e749fe4db08..9776595d5a7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for median_absolute_deviation agg + * + * @opensearch.internal + */ public class MedianAbsoluteDeviationAggregatorFactory extends ValuesSourceAggregatorFactory { private final double compression; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorSupplier.java index 6ae21171921..986e32cf438 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MedianAbsoluteDeviationAggregatorSupplier.java @@ -39,6 +39,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for median_absolute_deviation agg + * + * @opensearch.internal + */ public interface MedianAbsoluteDeviationAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricAggregatorSupplier.java index f260da8a263..4e70d417c4b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricAggregatorSupplier.java @@ -38,6 +38,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for metric aggs + * + * @opensearch.internal + */ public interface MetricAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricInspectionHelper.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricInspectionHelper.java index 2ed48a97bc3..47e27da5394 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricInspectionHelper.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricInspectionHelper.java @@ -38,6 +38,8 @@ import org.opensearch.search.aggregations.pipeline.InternalDerivative; * helpers for some aggs that have package-private getters. AggregationInspectionHelper delegates to these * helpers when needed, and consumers should prefer to use AggregationInspectionHelper instead of these * helpers. + * + * @opensearch.internal */ public class MetricInspectionHelper { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricsAggregator.java index f59daeb4690..0929fc60b02 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MetricsAggregator.java @@ -42,6 +42,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base aggregator to aggregate all docs into a single metric + * + * @opensearch.internal + */ public abstract class MetricsAggregator extends AggregatorBase { protected MetricsAggregator(String name, SearchContext context, Aggregator parent, Map metadata) throws IOException { super(name, AggregatorFactories.EMPTY, context, parent, CardinalityUpperBound.NONE, metadata); diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Min.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Min.java index dd3aea059e8..b99e08c9df8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Min.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Min.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes the minimum of the values in the current bucket. + * + * @opensearch.internal */ public interface Min extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregationBuilder.java index 89797710a40..45c69363bce 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregationBuilder.java @@ -50,6 +50,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for min agg + * + * @opensearch.internal + */ public class MinAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "min"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregator.java index 372fd936fa7..946057e42ac 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregator.java @@ -56,6 +56,11 @@ import java.io.IOException; import java.util.Map; import java.util.function.Function; +/** + * Aggregate all docs into a min value + * + * @opensearch.internal + */ class MinAggregator extends NumericMetricsAggregator.SingleValue { private static final int MAX_BKD_LOOKUPS = 1024; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregatorFactory.java index 3db64aa05bb..1b24b88d6f0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/MinAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for min agg + * + * @opensearch.internal + */ class MinAggregatorFactory extends ValuesSourceAggregatorFactory { static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregation.java index acde7bc6f3d..88e292f4d4b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregation.java @@ -34,6 +34,11 @@ package org.opensearch.search.aggregations.metrics; import org.opensearch.search.aggregations.Aggregation; +/** + * Base numeric metrics aggregation class + * + * @opensearch.internal + */ public interface NumericMetricsAggregation extends Aggregation { interface SingleValue extends NumericMetricsAggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregator.java index 9a4c0be0b7c..96d2d525e83 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/NumericMetricsAggregator.java @@ -39,6 +39,11 @@ import org.opensearch.search.sort.SortOrder; import java.io.IOException; import java.util.Map; +/** + * Base class to aggregate all docs into a single numeric metric value. + * + * @opensearch.internal + */ public abstract class NumericMetricsAggregator extends MetricsAggregator { private NumericMetricsAggregator(String name, SearchContext context, Aggregator parent, Map metadata) diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedAvg.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedAvg.java index 1242f61e75a..cc12044cba0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedAvg.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedAvg.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * An average agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedAvg extends ParsedSingleValueNumericMetricsAggregation implements Avg { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedCardinality.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedCardinality.java index 99bb36b900c..4c6e3f7c788 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedCardinality.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedCardinality.java @@ -39,6 +39,11 @@ import org.opensearch.search.aggregations.ParsedAggregation; import java.io.IOException; +/** + * A cardinality agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedCardinality extends ParsedAggregation implements Cardinality { private long cardinalityValue; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedExtendedStats.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedExtendedStats.java index 1cc0ab59030..0378ffff998 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedExtendedStats.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedExtendedStats.java @@ -48,6 +48,11 @@ import java.util.stream.Collectors; import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg; +/** + * An extended stats agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedExtendedStats extends ParsedStats implements ExtendedStats { protected double sumOfSquares; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoBounds.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoBounds.java index e0c734e4dc8..a482fcfdf08 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoBounds.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoBounds.java @@ -51,6 +51,11 @@ import static org.opensearch.common.geo.GeoBoundingBox.LON_FIELD; import static org.opensearch.common.geo.GeoBoundingBox.TOP_LEFT_FIELD; import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; +/** + * A geo bounds agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedGeoBounds extends ParsedAggregation implements GeoBounds { // A top of Double.NEGATIVE_INFINITY yields an empty xContent, so the bounding box is null diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java index 06e099f9709..04feb4a96dd 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedGeoCentroid.java @@ -43,6 +43,8 @@ import java.io.IOException; /** * Serialization and merge logic for {@link GeoCentroidAggregator}. + * + * @opensearch.internal */ public class ParsedGeoCentroid extends ParsedAggregation implements GeoCentroid { private GeoPoint centroid; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentileRanks.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentileRanks.java index 5faa795d8b6..e3c4ac5d3a4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentileRanks.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentileRanks.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; import java.util.Iterator; +/** + * An HDR agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedHDRPercentileRanks extends ParsedPercentileRanks { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentiles.java index f7a4afb86be..3a2f510ebb4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedHDRPercentiles.java @@ -37,6 +37,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * An HDR percentiles agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedHDRPercentiles extends ParsedPercentiles implements Percentiles { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMax.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMax.java index 2862a629ab7..ae91e4a3873 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMax.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMax.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A max agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedMax extends ParsedSingleValueNumericMetricsAggregation implements Max { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMedianAbsoluteDeviation.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMedianAbsoluteDeviation.java index 001e44736ae..9e2dc302545 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMedianAbsoluteDeviation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMedianAbsoluteDeviation.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A median absolute deviation agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedMedianAbsoluteDeviation extends ParsedSingleValueNumericMetricsAggregation implements MedianAbsoluteDeviation { private static final ObjectParser PARSER = new ObjectParser<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMin.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMin.java index 711a4e94b0e..f5d571b58e4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMin.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedMin.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A min agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedMin extends ParsedSingleValueNumericMetricsAggregation implements Min { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentileRanks.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentileRanks.java index 71773e80405..be57e85962e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentileRanks.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentileRanks.java @@ -32,6 +32,11 @@ package org.opensearch.search.aggregations.metrics; +/** + * A percentiles agg result parsed between nodes + * + * @opensearch.internal + */ abstract class ParsedPercentileRanks extends ParsedPercentiles implements PercentileRanks { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentiles.java index 06f8eba1f46..f6efeed0b96 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedPercentiles.java @@ -43,6 +43,11 @@ import java.util.Iterator; import java.util.LinkedHashMap; import java.util.Map; +/** + * A single percentiles agg result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedPercentiles extends ParsedAggregation implements Iterable { protected final Map percentiles = new LinkedHashMap<>(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedScriptedMetric.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedScriptedMetric.java index b7bc5a7d2c3..afd89bb9f9e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedScriptedMetric.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedScriptedMetric.java @@ -44,6 +44,11 @@ import java.io.IOException; import java.util.Collections; import java.util.List; +/** + * A scripted metric result parsed between nodes + * + * @opensearch.internal + */ public class ParsedScriptedMetric extends ParsedAggregation implements ScriptedMetric { private List aggregation; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSingleValueNumericMetricsAggregation.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSingleValueNumericMetricsAggregation.java index ae657e203fc..ebcf34b77fa 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSingleValueNumericMetricsAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSingleValueNumericMetricsAggregation.java @@ -35,6 +35,11 @@ import org.opensearch.common.xcontent.ObjectParser; import org.opensearch.common.xcontent.ObjectParser.ValueType; import org.opensearch.search.aggregations.ParsedAggregation; +/** + * A single value numeric agg result parsed between nodes + * + * @opensearch.internal + */ public abstract class ParsedSingleValueNumericMetricsAggregation extends ParsedAggregation implements NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedStats.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedStats.java index 55258f1e109..0c83417a826 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedStats.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedStats.java @@ -44,6 +44,11 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; +/** + * A stats agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedStats extends ParsedAggregation implements Stats { protected long count; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSum.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSum.java index 2f5d8fca166..73024e26128 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSum.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedSum.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A sum agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedSum extends ParsedSingleValueNumericMetricsAggregation implements Sum { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentileRanks.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentileRanks.java index f1cfaf3f088..c7cf92f6a08 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentileRanks.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentileRanks.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; import java.util.Iterator; +/** + * A TDigest percentiles rank agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedTDigestPercentileRanks extends ParsedPercentileRanks { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentiles.java index 9b6090c3de2..36531ad7e69 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTDigestPercentiles.java @@ -37,6 +37,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A single TDigest percentiles result parsed between nodes + * + * @opensearch.internal + */ public class ParsedTDigestPercentiles extends ParsedPercentiles implements Percentiles { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTopHits.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTopHits.java index 9d52e71cbfe..b0c5709c9ba 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTopHits.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedTopHits.java @@ -41,6 +41,11 @@ import org.opensearch.search.aggregations.ParsedAggregation; import java.io.IOException; +/** + * A top_hits agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedTopHits extends ParsedAggregation implements TopHits { private SearchHits searchHits; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedValueCount.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedValueCount.java index 305cee74064..0e3f8f56331 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedValueCount.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedValueCount.java @@ -39,6 +39,11 @@ import org.opensearch.search.aggregations.ParsedAggregation; import java.io.IOException; +/** + * A value count agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedValueCount extends ParsedAggregation implements ValueCount { private long valueCount; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedWeightedAvg.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedWeightedAvg.java index 680f6274c8e..f67fd13a8cc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedWeightedAvg.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ParsedWeightedAvg.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A weighted average agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedWeightedAvg extends ParsedSingleValueNumericMetricsAggregation implements WeightedAvg { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentile.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentile.java index d797e602b2d..50ebd6f343f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentile.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentile.java @@ -34,6 +34,11 @@ package org.opensearch.search.aggregations.metrics; import java.util.Objects; +/** + * Implementation of a percentile + * + * @opensearch.internal + */ public class Percentile { private final double percent; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanks.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanks.java index 00725b20f80..b4a6dc39a44 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanks.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanks.java @@ -34,6 +34,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes approximate percentiles given values. + * + * @opensearch.internal */ public interface PercentileRanks extends NumericMetricsAggregation.MultiValue, Iterable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregationBuilder.java index 037830c63ec..e63830fa7ed 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregationBuilder.java @@ -49,6 +49,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for percentile_ranks agg + * + * @opensearch.internal + */ public class PercentileRanksAggregationBuilder extends AbstractPercentilesAggregationBuilder { public static final String NAME = PercentileRanks.TYPE_NAME; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregatorFactory.java index 059b9dd7d0d..19352d30a51 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentileRanksAggregatorFactory.java @@ -47,6 +47,11 @@ import java.io.IOException; import java.util.Arrays; import java.util.Map; +/** + * Base Aggregation Factory for ranks aggs + * + * @opensearch.internal + */ class PercentileRanksAggregatorFactory extends ValuesSourceAggregatorFactory { private final double[] percents; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentiles.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentiles.java index 5b40a2ce8f2..f6bf9d1f823 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentiles.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Percentiles.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes approximate percentiles. + * + * @opensearch.internal */ public interface Percentiles extends NumericMetricsAggregation.MultiValue, Iterable { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregationBuilder.java index 323723bb6de..ef80e86661c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregationBuilder.java @@ -50,6 +50,11 @@ import java.io.IOException; import java.util.Arrays; import java.util.Map; +/** + * Aggregation Builder for percentiles agg + * + * @opensearch.internal + */ public class PercentilesAggregationBuilder extends AbstractPercentilesAggregationBuilder { public static final String NAME = Percentiles.TYPE_NAME; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorFactory.java index 15f30107199..e249863e253 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorFactory.java @@ -50,6 +50,8 @@ import java.util.Map; /** * This factory is used to generate both TDigest and HDRHisto aggregators, depending * on the selected method + * + * @opensearch.internal */ class PercentilesAggregatorFactory extends ValuesSourceAggregatorFactory { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorSupplier.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorSupplier.java index d65619be5bc..8f6e36a3ac8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorSupplier.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesAggregatorSupplier.java @@ -39,6 +39,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregator supplier interface for percentiles aggs + * + * @opensearch.internal + */ public interface PercentilesAggregatorSupplier { Aggregator build( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesConfig.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesConfig.java index 26ef2727832..f20cf2eb223 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesConfig.java @@ -50,6 +50,8 @@ import java.util.Objects; * A small config object that carries algo-specific settings. This allows the factory to have * a single unified constructor for both algos, but internally switch execution * depending on which algo is selected + * + * @opensearch.internal */ public abstract class PercentilesConfig implements ToXContent, Writeable { private final PercentilesMethod method; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesMethod.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesMethod.java index b167251861b..ee7b7453826 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesMethod.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/PercentilesMethod.java @@ -42,6 +42,8 @@ import java.io.IOException; /** * An enum representing the methods for calculating percentiles + * + * @opensearch.internal */ public enum PercentilesMethod implements Writeable { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetric.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetric.java index 3cf6da01e0f..487e7c9de22 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetric.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetric.java @@ -36,6 +36,8 @@ import org.opensearch.search.aggregations.Aggregation; /** * A metric aggregation that computes both its final and intermediate states using scripts. + * + * @opensearch.internal */ public interface ScriptedMetric extends Aggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregationBuilder.java index 4564977f094..7a2b733a67d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregationBuilder.java @@ -52,6 +52,11 @@ import java.util.Objects; import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; +/** + * Aggregation Builder for scripted_metric agg + * + * @opensearch.internal + */ public class ScriptedMetricAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "scripted_metric"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregator.java index 8ff0e33afbc..2a2943e9315 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregator.java @@ -56,6 +56,11 @@ import java.util.Map; import static java.util.Collections.singletonList; +/** + * Aggregate all docs based on a value script + * + * @opensearch.internal + */ class ScriptedMetricAggregator extends MetricsAggregator { /** * Estimated cost to maintain a bucket. Since this aggregator uses diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregatorFactory.java index 53e865b2f04..7b5848fc791 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ScriptedMetricAggregatorFactory.java @@ -50,6 +50,11 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +/** + * Aggregation Factory for scripted_metrics agg + * + * @opensearch.internal + */ class ScriptedMetricAggregatorFactory extends AggregatorFactory { private final ScriptedMetricAggContexts.MapScript.Factory mapScript; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Stats.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Stats.java index 4228996f426..4e854196f38 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Stats.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Stats.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * Statistics over a set of values (either aggregated over field data or scripts) + * + * @opensearch.internal */ public interface Stats extends NumericMetricsAggregation.MultiValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregationBuilder.java index da38127c80d..9de5e4d9f9b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregationBuilder.java @@ -50,6 +50,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for stats agg + * + * @opensearch.internal + */ public class StatsAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "stats"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregator.java index 069721e3753..c52638fe4b9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregator.java @@ -50,6 +50,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into their basic descriptive statistics + * + * @opensearch.internal + */ class StatsAggregator extends NumericMetricsAggregator.MultiValue { final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregatorFactory.java index 01772df17a9..6e343ed9a31 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/StatsAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for stats agg + * + * @opensearch.internal + */ class StatsAggregatorFactory extends ValuesSourceAggregatorFactory { StatsAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/Sum.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/Sum.java index cee960280e0..e58a9e504cf 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/Sum.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/Sum.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes the sum of the values in the current bucket. + * + * @opensearch.internal */ public interface Sum extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregationBuilder.java index dee421d8bd3..d6d33eae90c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregationBuilder.java @@ -50,6 +50,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for sum agg + * + * @opensearch.internal + */ public class SumAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "sum"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregator.java index 82799d8e9f3..4b8e882cd69 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregator.java @@ -49,6 +49,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a single sum value + * + * @opensearch.internal + */ public class SumAggregator extends NumericMetricsAggregator.SingleValue { private final ValuesSource.Numeric valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregatorFactory.java index c05b438b068..c94949bca09 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/SumAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for sum agg + * + * @opensearch.internal + */ class SumAggregatorFactory extends ValuesSourceAggregatorFactory { SumAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentileRanksAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentileRanksAggregator.java index c61a55950b7..8c7b71561ed 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentileRanksAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentileRanksAggregator.java @@ -40,6 +40,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a the TDigenst Percentile Ranks + * + * @opensearch.internal + */ class TDigestPercentileRanksAggregator extends AbstractTDigestPercentilesAggregator { TDigestPercentileRanksAggregator( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentilesAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentilesAggregator.java index 4c9213f35d1..a5844858d29 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentilesAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestPercentilesAggregator.java @@ -40,6 +40,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a single TDigest Percentile + * + * @opensearch.internal + */ class TDigestPercentilesAggregator extends AbstractTDigestPercentilesAggregator { TDigestPercentilesAggregator( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestState.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestState.java index c6ea32d6e96..e551d0e9d4f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestState.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TDigestState.java @@ -41,6 +41,8 @@ import java.util.Iterator; /** * Extension of {@link com.tdunning.math.stats.TDigest} with custom serialization. + * + * @opensearch.internal */ public class TDigestState extends AVLTreeDigest { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHits.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHits.java index dc6b02636d6..101af7daafa 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHits.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHits.java @@ -36,6 +36,8 @@ import org.opensearch.search.aggregations.Aggregation; /** * Accumulation of the most relevant hits for a bucket this aggregation falls into. + * + * @opensearch.internal */ public interface TopHits extends Aggregation { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregationBuilder.java index d1097aaa206..f88a47fc745 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregationBuilder.java @@ -72,6 +72,11 @@ import java.util.Objects; import java.util.Optional; import java.util.Set; +/** + * Aggregation Builder for top_hits agg + * + * @opensearch.internal + */ public class TopHitsAggregationBuilder extends AbstractAggregationBuilder { public static final String NAME = "top_hits"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregator.java index 94425501de3..2964ede7979 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregator.java @@ -70,6 +70,11 @@ import org.opensearch.search.sort.SortAndFormats; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into the top hits + * + * @opensearch.internal + */ class TopHitsAggregator extends MetricsAggregator { private static class Collectors { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregatorFactory.java index b9699964a61..e312983cd6d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/TopHitsAggregatorFactory.java @@ -53,6 +53,11 @@ import java.util.List; import java.util.Map; import java.util.Optional; +/** + * Aggregation Factory for top_hits agg + * + * @opensearch.internal + */ class TopHitsAggregatorFactory extends AggregatorFactory { private final int from; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCount.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCount.java index 158c29eca4c..8c35a6a7ac7 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCount.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCount.java @@ -34,6 +34,8 @@ package org.opensearch.search.aggregations.metrics; /** * An get that holds the number of values that the current document set has for a specific * field. + * + * @opensearch.internal */ public interface ValueCount extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregationBuilder.java index 246609f5185..2a459bb8430 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregationBuilder.java @@ -51,6 +51,11 @@ import org.opensearch.search.aggregations.support.ValuesSourceType; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for value_count agg + * + * @opensearch.internal + */ public class ValueCountAggregationBuilder extends ValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "value_count"; public static final ValuesSourceRegistry.RegistryKey REGISTRY_KEY = new ValuesSourceRegistry.RegistryKey<>( diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregator.java index 4ba2245e977..be98df384fc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregator.java @@ -55,6 +55,8 @@ import java.util.Map; * * This aggregator works in a multi-bucket mode, that is, when serves as a sub-aggregator, a single aggregator instance aggregates the * counts for all buckets owned by the parent aggregator) + * + * @opensearch.internal */ public class ValueCountAggregator extends NumericMetricsAggregator.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregatorFactory.java index 1542f25dd49..feed42e9118 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/ValueCountAggregatorFactory.java @@ -46,6 +46,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Aggregation Factory for value_count agg + * + * @opensearch.internal + */ class ValueCountAggregatorFactory extends ValuesSourceAggregatorFactory { public static void registerAggregators(ValuesSourceRegistry.Builder builder) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvg.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvg.java index 8afd013f730..b81520f8790 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvg.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvg.java @@ -33,6 +33,8 @@ package org.opensearch.search.aggregations.metrics; /** * An aggregation that computes the average of the values in the current bucket. + * + * @opensearch.internal */ public interface WeightedAvg extends NumericMetricsAggregation.SingleValue { diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregationBuilder.java index 6afad18ddd2..1dccbba0ec5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregationBuilder.java @@ -58,6 +58,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for weighted_avg agg + * + * @opensearch.internal + */ public class WeightedAvgAggregationBuilder extends MultiValuesSourceAggregationBuilder.LeafOnly { public static final String NAME = "weighted_avg"; public static final ParseField VALUE_FIELD = new ParseField("value"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregator.java index 6498674e838..d85ee651cb5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregator.java @@ -52,6 +52,11 @@ import java.util.Map; import static org.opensearch.search.aggregations.metrics.WeightedAvgAggregationBuilder.VALUE_FIELD; import static org.opensearch.search.aggregations.metrics.WeightedAvgAggregationBuilder.WEIGHT_FIELD; +/** + * Aggregate all docs into a weighted average + * + * @opensearch.internal + */ class WeightedAvgAggregator extends NumericMetricsAggregator.SingleValue { private final MultiValuesSource.NumericMultiValuesSource valuesSources; diff --git a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregatorFactory.java index add0933d400..9a27e9801d5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/metrics/WeightedAvgAggregatorFactory.java @@ -48,6 +48,11 @@ import java.util.Map; import static org.opensearch.search.aggregations.metrics.WeightedAvgAggregationBuilder.VALUE_FIELD; +/** + * Aggregation Factory for weighted_avg agg + * + * @opensearch.internal + */ class WeightedAvgAggregatorFactory extends MultiValuesSourceAggregatorFactory { WeightedAvgAggregatorFactory( diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/AbstractPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/AbstractPipelineAggregationBuilder.java index 290e13b2ee4..5d7acc0ec3d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/AbstractPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/AbstractPipelineAggregationBuilder.java @@ -44,6 +44,8 @@ import java.util.Objects; /** * Base implementation of a {@link PipelineAggregationBuilder}. + * + * @opensearch.internal */ public abstract class AbstractPipelineAggregationBuilder> extends PipelineAggregationBuilder { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregationBuilder.java index 619d7aa5d44..e0c1abc304b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregationBuilder.java @@ -39,6 +39,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for avg_bucket agg + * + * @opensearch.internal + */ public class AvgBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder { public static final String NAME = "avg_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregator.java index 5aea6e1893c..e9e1f13a807 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/AvgBucketPipelineAggregator.java @@ -40,6 +40,11 @@ import org.opensearch.search.aggregations.pipeline.BucketHelpers.GapPolicy; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into an average bucket + * + * @opensearch.internal + */ public class AvgBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private int count = 0; private double sum = 0; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketHelpers.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketHelpers.java index d73b7a23300..d7f82f36a3a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketHelpers.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketHelpers.java @@ -54,6 +54,8 @@ import java.util.List; /** * A set of static helpers to simplify working with aggregation buckets, in * particular providing utilities that help pipeline aggregations. + * + * @opensearch.internal */ public class BucketHelpers { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricValue.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricValue.java index 04335c2200e..bada4fedcec 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricValue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricValue.java @@ -34,6 +34,11 @@ package org.opensearch.search.aggregations.pipeline; import org.opensearch.search.aggregations.metrics.NumericMetricsAggregation; +/** + * Base class of a metric value for a bucket + * + * @opensearch.internal + */ public interface BucketMetricValue extends NumericMetricsAggregation.SingleValue { String[] keys(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsParser.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsParser.java index b6c78f63687..d1de39600ad 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsParser.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsParser.java @@ -45,6 +45,8 @@ import java.util.Map; /** * A parser for parsing requests for a {@link BucketMetricsPipelineAggregator} + * + * @opensearch.internal */ public abstract class BucketMetricsParser implements PipelineAggregator.Parser { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregationBuilder.java index 239a8e61595..f0d7ee4246a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregationBuilder.java @@ -44,6 +44,11 @@ import java.util.Map; import java.util.Objects; import java.util.Optional; +/** + * Base Aggregation Builder for bucket metrics pipeline aggs + * + * @opensearch.internal + */ public abstract class BucketMetricsPipelineAggregationBuilder> extends AbstractPipelineAggregationBuilder { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregator.java index 5f690725b29..4836428027f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketMetricsPipelineAggregator.java @@ -50,6 +50,8 @@ import java.util.Map; /** * A class of sibling pipeline aggregations which calculate metrics across the * buckets of a sibling aggregation + * + * @opensearch.internal */ public abstract class BucketMetricsPipelineAggregator extends SiblingPipelineAggregator { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregationBuilder.java index 9c633ddfa40..d238791cdda 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregationBuilder.java @@ -56,6 +56,11 @@ import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Par import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.FORMAT; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.GAP_POLICY; +/** + * Aggregation Builder for bucket_script agg + * + * @opensearch.internal + */ public class BucketScriptPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "bucket_script"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregator.java index 3c100bae08a..abf98b6ea4a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketScriptPipelineAggregator.java @@ -53,6 +53,11 @@ import java.util.stream.StreamSupport; import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveBucketValue; +/** + * Aggregate all docs into a bucket defined by a script + * + * @opensearch.internal + */ public class BucketScriptPipelineAggregator extends PipelineAggregator { private final DocValueFormat formatter; private final GapPolicy gapPolicy; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregationBuilder.java index b2887ffc7e7..929dcd30e5a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregationBuilder.java @@ -51,6 +51,11 @@ import java.util.TreeMap; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.BUCKETS_PATH; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.GAP_POLICY; +/** + * Aggregation Builder for bucket_selector agg + * + * @opensearch.internal + */ public class BucketSelectorPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "bucket_selector"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregator.java index 316dee93f1c..8f5426eae83 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSelectorPipelineAggregator.java @@ -49,6 +49,11 @@ import java.util.Map; import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveBucketValue; +/** + * Aggregate all docs into a selected bucket + * + * @opensearch.internal + */ public class BucketSelectorPipelineAggregator extends PipelineAggregator { private GapPolicy gapPolicy; private Script script; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregationBuilder.java index cc780829bf9..ce9d3150437 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregationBuilder.java @@ -60,6 +60,8 @@ import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Par * aggregation. The bucket {@code _key}, {@code _count} or sub-aggregations may be used as sort * keys. Parameters {@code from} and {@code size} may also be set in order to truncate the * result bucket list. + * + * @opensearch.internal */ public class BucketSortPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "bucket_sort"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregator.java index 77058809e71..809514614b1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/BucketSortPipelineAggregator.java @@ -48,6 +48,11 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +/** + * Aggregate all docs into sorted buckets + * + * @opensearch.internal + */ public class BucketSortPipelineAggregator extends PipelineAggregator { private final List sorts; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregationBuilder.java index fd31bbc6d4a..80321016867 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregationBuilder.java @@ -46,6 +46,11 @@ import java.util.Objects; import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.FORMAT; +/** + * Aggregation Builder for cumulative_sum pipeline agg + * + * @opensearch.internal + */ public class CumulativeSumPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "cumulative_sum"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregator.java index 0903fbf8581..cba35c89cc6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/CumulativeSumPipelineAggregator.java @@ -52,6 +52,11 @@ import java.util.stream.StreamSupport; import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveBucketValue; +/** + * Aggregate all docs into a cumulative sum bucket + * + * @opensearch.internal + */ public class CumulativeSumPipelineAggregator extends PipelineAggregator { private final DocValueFormat formatter; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/Derivative.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/Derivative.java index bbe87f5c27d..eb92a78f716 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/Derivative.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/Derivative.java @@ -32,6 +32,11 @@ package org.opensearch.search.aggregations.pipeline; +/** + * Base class of a derivitive + * + * @opensearch.internal + */ public interface Derivative extends SimpleValue { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregationBuilder.java index b5d6f3d2066..1455c2d6d87 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregationBuilder.java @@ -51,6 +51,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for derivative agg + * + * @opensearch.internal + */ public class DerivativePipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "derivative"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregator.java index 6312b479e32..3603d1c5a0c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/DerivativePipelineAggregator.java @@ -52,6 +52,11 @@ import java.util.stream.StreamSupport; import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveBucketValue; +/** + * Aggregate all docs into a derivative value + * + * @opensearch.internal + */ public class DerivativePipelineAggregator extends PipelineAggregator { private final DocValueFormat formatter; private final GapPolicy gapPolicy; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/EwmaModel.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/EwmaModel.java index 6545db9117e..1fc86dce353 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/EwmaModel.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/EwmaModel.java @@ -46,6 +46,8 @@ import java.util.Objects; /** * Calculate a exponentially weighted moving average + * + * @opensearch.internal */ public class EwmaModel extends MovAvgModel { public static final String NAME = "ewma"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucket.java index 253901a40d0..1e74c18e5f8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucket.java @@ -36,5 +36,7 @@ import org.opensearch.search.aggregations.metrics.ExtendedStats; /** * Extended Statistics over a set of buckets + * + * @opensearch.internal */ public interface ExtendedStatsBucket extends ExtendedStats {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketParser.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketParser.java index d9f7765dc51..aac7e2b0852 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketParser.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketParser.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; import java.util.Map; +/** + * Parses extended stats values + * + * @opensearch.internal + */ public class ExtendedStatsBucketParser extends BucketMetricsParser { static final ParseField SIGMA = new ParseField("sigma"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregationBuilder.java index 1c44a7c7c1c..746d80d9e58 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregationBuilder.java @@ -40,6 +40,11 @@ import java.io.IOException; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for extended_stats agg + * + * @opensearch.internal + */ public class ExtendedStatsBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder< ExtendedStatsBucketPipelineAggregationBuilder> { public static final String NAME = "extended_stats_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregator.java index 0c6121217dc..a63a1da332d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ExtendedStatsBucketPipelineAggregator.java @@ -41,6 +41,11 @@ import org.opensearch.search.aggregations.pipeline.BucketHelpers.GapPolicy; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into their extended stats + * + * @opensearch.internal + */ public class ExtendedStatsBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private final double sigma; private double sum = 0; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltLinearModel.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltLinearModel.java index 51ed0466d0b..510f3396cf8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltLinearModel.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltLinearModel.java @@ -45,6 +45,8 @@ import java.util.Objects; /** * Calculate a doubly exponential weighted moving average + * + * @opensearch.internal */ public class HoltLinearModel extends MovAvgModel { public static final String NAME = "holt"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltWintersModel.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltWintersModel.java index 474c91573c5..1dccb17d78b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltWintersModel.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/HoltWintersModel.java @@ -50,6 +50,8 @@ import java.util.Objects; /** * Calculate a triple exponential weighted moving average + * + * @opensearch.internal */ public class HoltWintersModel extends MovAvgModel { public static final String NAME = "holt_winters"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalBucketMetricValue.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalBucketMetricValue.java index 4e0566250eb..4769ef94150 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalBucketMetricValue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalBucketMetricValue.java @@ -46,6 +46,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of a bucket metric value + * + * @opensearch.internal + */ public class InternalBucketMetricValue extends InternalNumericMetricsAggregation.SingleValue implements BucketMetricValue { public static final String NAME = "bucket_metric_value"; static final ParseField KEYS_FIELD = new ParseField("keys"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalDerivative.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalDerivative.java index 81fcbe09176..2fd5074437c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalDerivative.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalDerivative.java @@ -42,6 +42,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of derivitive pipeline + * + * @opensearch.internal + */ public class InternalDerivative extends InternalSimpleValue implements Derivative { private final double normalizationFactor; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalExtendedStatsBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalExtendedStatsBucket.java index b01b7be6a9c..26781eba3e0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalExtendedStatsBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalExtendedStatsBucket.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Implementation of extended stats pipeline + * + * @opensearch.internal + */ public class InternalExtendedStatsBucket extends InternalExtendedStats implements ExtendedStatsBucket { InternalExtendedStatsBucket( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalPercentilesBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalPercentilesBucket.java index 4603d683255..95028c5a560 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalPercentilesBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalPercentilesBucket.java @@ -50,6 +50,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of percentiles pipeline + * + * @opensearch.internal + */ public class InternalPercentilesBucket extends InternalNumericMetricsAggregation.MultiValue implements PercentilesBucket { private double[] percentiles; private double[] percents; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalSimpleValue.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalSimpleValue.java index e3f505e52b2..66bef036223 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalSimpleValue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalSimpleValue.java @@ -44,6 +44,11 @@ import java.util.List; import java.util.Map; import java.util.Objects; +/** + * Implementation of simple value pipeline + * + * @opensearch.internal + */ public class InternalSimpleValue extends InternalNumericMetricsAggregation.SingleValue implements SimpleValue { public static final String NAME = "simple_value"; protected final double value; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalStatsBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalStatsBucket.java index 44916c80cab..2754376059d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalStatsBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/InternalStatsBucket.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Implementation of stats pipeline + * + * @opensearch.internal + */ public class InternalStatsBucket extends InternalStats implements StatsBucket { public InternalStatsBucket( String name, diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/LinearModel.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/LinearModel.java index 0e1ffdbedcf..1595c0f5f45 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/LinearModel.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/LinearModel.java @@ -46,6 +46,8 @@ import java.util.Map; /** * Calculate a linearly weighted moving average, such that older values are * linearly less important. "Time" is determined by position in collection + * + * @opensearch.internal */ public class LinearModel extends MovAvgModel { public static final String NAME = "linear"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregationBuilder.java index 854ea18021b..ecf4e59bb8a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregationBuilder.java @@ -39,6 +39,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for max_bucket agg + * + * @opensearch.internal + */ public class MaxBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder { public static final String NAME = "max_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregator.java index 03bf1c78a82..1e327919755 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MaxBucketPipelineAggregator.java @@ -42,6 +42,11 @@ import java.util.ArrayList; import java.util.List; import java.util.Map; +/** + * Aggregate all docs into a max bucket + * + * @opensearch.internal + */ public class MaxBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private List maxBucketKeys; private double maxValue; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregationBuilder.java index 96ab48b01c1..ec2b9ab07f5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregationBuilder.java @@ -39,6 +39,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for min_bucket + * + * @opensearch.internal + */ public class MinBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder { public static final String NAME = "min_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregator.java index 137aac02b83..2b57aac14ea 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MinBucketPipelineAggregator.java @@ -42,6 +42,11 @@ import java.util.ArrayList; import java.util.List; import java.util.Map; +/** + * Aggregate all docs into a min bucket + * + * @opensearch.internal + */ public class MinBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private List minBucketKeys; private double minValue; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModel.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModel.java index b63fee917ce..6b7497235ef 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModel.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModel.java @@ -43,6 +43,11 @@ import java.util.Arrays; import java.util.Collection; import java.util.Map; +/** + * Base moving average model class + * + * @opensearch.internal + */ public abstract class MovAvgModel implements NamedWriteable, ToXContentFragment { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModelBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModelBuilder.java index c369a127c16..d89abb61db1 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModelBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgModelBuilder.java @@ -37,6 +37,8 @@ import org.opensearch.common.xcontent.ToXContentFragment; /** * Represents the common interface that all moving average models share. Moving * average models are used by the MovAvg aggregation + * + * @opensearch.internal */ public interface MovAvgModelBuilder extends ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregationBuilder.java index 298720785f4..5f94c21da39 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregationBuilder.java @@ -54,6 +54,11 @@ import org.opensearch.common.xcontent.XContentParser; import org.opensearch.search.DocValueFormat; import org.opensearch.search.aggregations.pipeline.BucketHelpers.GapPolicy; +/** + * Aggregation Builder for moving_avg + * + * @opensearch.internal + */ public class MovAvgPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "moving_avg"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregator.java index d4ce4170e10..2e3c44ac390 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovAvgPipelineAggregator.java @@ -55,6 +55,11 @@ import java.util.stream.StreamSupport; import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveBucketValue; +/** + * Aggregate all docs into a moving average bucket + * + * @opensearch.internal + */ public class MovAvgPipelineAggregator extends PipelineAggregator { private final DocValueFormat formatter; private final GapPolicy gapPolicy; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregationBuilder.java index 56f7ab0c333..33c09e04bd4 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregationBuilder.java @@ -55,6 +55,11 @@ import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Par import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.FORMAT; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.GAP_POLICY; +/** + * Aggregation Builder for moving_fn + * + * @opensearch.internal + */ public class MovFnPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "moving_fn"; private static final ParseField WINDOW = new ParseField("window"); diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregator.java index 7f1bb8965ed..70652e7ddce 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovFnPipelineAggregator.java @@ -69,6 +69,8 @@ import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveB * - holtWintersMovAvg * * The user can also define any arbitrary logic via their own scripting, or combine with the above methods. + * + * @opensearch.internal */ public class MovFnPipelineAggregator extends PipelineAggregator { private final DocValueFormat formatter; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctionScript.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctionScript.java index 23fcd8b25b3..ff5a4f254e6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctionScript.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctionScript.java @@ -40,6 +40,8 @@ import java.util.Map; /** * This class provides a custom script context for the Moving Function pipeline aggregation, * so that we can expose a number of pre-baked moving functions like min, max, movavg, etc + * + * @opensearch.internal */ public abstract class MovingFunctionScript { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctions.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctions.java index e3a57654f94..bac486576f5 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctions.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/MovingFunctions.java @@ -36,6 +36,8 @@ import java.util.Arrays; /** * Provides a collection of static utility methods that can be referenced from MovingFunction script contexts + * + * @opensearch.internal */ public class MovingFunctions { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedBucketMetricValue.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedBucketMetricValue.java index 7ecbd64d9cf..e91d31586c0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedBucketMetricValue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedBucketMetricValue.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.Collections; import java.util.List; +/** + * A bucket metric agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedBucketMetricValue extends ParsedSingleValueNumericMetricsAggregation implements BucketMetricValue { private List keys = Collections.emptyList(); diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedDerivative.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedDerivative.java index 0ce2c121f06..62fac352bb8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedDerivative.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedDerivative.java @@ -40,6 +40,11 @@ import org.opensearch.common.xcontent.XContentParser; import java.io.IOException; +/** + * A derivative agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedDerivative extends ParsedSimpleValue implements Derivative { private double normalizedValue; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedExtendedStatsBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedExtendedStatsBucket.java index 0a518a8363a..6be430d49c9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedExtendedStatsBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedExtendedStatsBucket.java @@ -36,6 +36,11 @@ import org.opensearch.common.xcontent.ObjectParser; import org.opensearch.common.xcontent.XContentParser; import org.opensearch.search.aggregations.metrics.ParsedExtendedStats; +/** + * An extended stats agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedExtendedStatsBucket extends ParsedExtendedStats implements ExtendedStatsBucket { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedPercentilesBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedPercentilesBucket.java index fe274862c06..96a877dcda6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedPercentilesBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedPercentilesBucket.java @@ -41,6 +41,11 @@ import org.opensearch.search.aggregations.metrics.Percentiles; import java.io.IOException; import java.util.Map.Entry; +/** + * A percentiles bucket agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedPercentilesBucket extends ParsedPercentiles implements Percentiles { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedSimpleValue.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedSimpleValue.java index 30cffd8fdf4..a5b9833814c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedSimpleValue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedSimpleValue.java @@ -39,6 +39,11 @@ import org.opensearch.search.aggregations.metrics.ParsedSingleValueNumericMetric import java.io.IOException; +/** + * A simple value agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedSimpleValue extends ParsedSingleValueNumericMetricsAggregation implements SimpleValue { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedStatsBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedStatsBucket.java index fc20befbd5c..e0731dd9e9c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedStatsBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/ParsedStatsBucket.java @@ -36,6 +36,11 @@ import org.opensearch.common.xcontent.ObjectParser; import org.opensearch.common.xcontent.XContentParser; import org.opensearch.search.aggregations.metrics.ParsedStats; +/** + * A stats agg result parsed between nodes + * + * @opensearch.internal + */ public class ParsedStatsBucket extends ParsedStats implements StatsBucket { @Override diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucket.java index e335dbbaa3d..fadc32192a6 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucket.java @@ -34,4 +34,9 @@ package org.opensearch.search.aggregations.pipeline; import org.opensearch.search.aggregations.metrics.Percentiles; +/** + * Base noop bucket implementation for percentiles + * + * @opensearch.internal + */ public interface PercentilesBucket extends Percentiles {} diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregationBuilder.java index 01d30185917..bef97bbbaa8 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregationBuilder.java @@ -46,6 +46,11 @@ import java.util.Arrays; import java.util.Map; import java.util.Objects; +/** + * Aggregation Builder for percentiles_bucket + * + * @opensearch.internal + */ public class PercentilesBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder< PercentilesBucketPipelineAggregationBuilder> { public static final String NAME = "percentiles_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregator.java index 02cb75b37c6..bd838fe23da 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PercentilesBucketPipelineAggregator.java @@ -45,6 +45,11 @@ import java.util.Collections; import java.util.List; import java.util.Map; +/** + * Aggregate all docs into a percentiles bucket + * + * @opensearch.internal + */ public class PercentilesBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private final double[] percents; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PipelineAggregator.java index ae0a81f27bf..da4a3b90b27 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/PipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/PipelineAggregator.java @@ -49,6 +49,11 @@ import java.util.Map; import static java.util.Collections.emptyList; import static java.util.Collections.emptyMap; +/** + * Base aggregator for pipline aggs + * + * @opensearch.internal + */ public abstract class PipelineAggregator implements NamedWriteable { /** * Parse the {@link PipelineAggregationBuilder} from a {@link XContentParser}. diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregationBuilder.java index 2b07442b807..e3140ed77d3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregationBuilder.java @@ -50,6 +50,11 @@ import java.util.Objects; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.BUCKETS_PATH; import static org.opensearch.search.aggregations.pipeline.PipelineAggregator.Parser.FORMAT; +/** + * Aggregation Builder for serial_diff agg + * + * @opensearch.internal + */ public class SerialDiffPipelineAggregationBuilder extends AbstractPipelineAggregationBuilder { public static final String NAME = "serial_diff"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregator.java index eea9f76d5d0..b06b6aa5121 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SerialDiffPipelineAggregator.java @@ -54,6 +54,11 @@ import java.util.stream.StreamSupport; import static org.opensearch.search.aggregations.pipeline.BucketHelpers.resolveBucketValue; +/** + * Aggregate all docs into a serial diff bucket + * + * @opensearch.internal + */ public class SerialDiffPipelineAggregator extends PipelineAggregator { private DocValueFormat formatter; private GapPolicy gapPolicy; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SiblingPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SiblingPipelineAggregator.java index 2375b75d30a..40cf1ab115a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SiblingPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SiblingPipelineAggregator.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.List; import java.util.Map; +/** + * Aggregate all docs into a sibling bucket + * + * @opensearch.internal + */ public abstract class SiblingPipelineAggregator extends PipelineAggregator { protected SiblingPipelineAggregator(String name, String[] bucketsPaths, Map metadata) { super(name, bucketsPaths, metadata); diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleModel.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleModel.java index b133308b61e..4336311c82b 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleModel.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleModel.java @@ -45,6 +45,8 @@ import java.util.Map; /** * Calculate a simple unweighted (arithmetic) moving average + * + * @opensearch.internal */ public class SimpleModel extends MovAvgModel { public static final String NAME = "simple"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleValue.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleValue.java index 4e3a7b65eb9..f062164adab 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleValue.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimpleValue.java @@ -34,6 +34,11 @@ package org.opensearch.search.aggregations.pipeline; import org.opensearch.search.aggregations.metrics.NumericMetricsAggregation; +/** + * Base noop class for simple values + * + * @opensearch.internal + */ public interface SimpleValue extends NumericMetricsAggregation.SingleValue { } diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimulatedAnealingMinimizer.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimulatedAnealingMinimizer.java index 19d06cec15f..a61a8662281 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimulatedAnealingMinimizer.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SimulatedAnealingMinimizer.java @@ -46,6 +46,8 @@ import org.opensearch.common.collect.EvictingQueue; * anyway. This allows the algo to sample the problem space widely. As iterations progress, * the temperature decreases and the algorithm rejects poor solutions more regularly, * theoretically honing in on a global minimum. + * + * @opensearch.internal */ public class SimulatedAnealingMinimizer { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucket.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucket.java index e846a7a90d6..69953075032 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucket.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucket.java @@ -36,6 +36,8 @@ import org.opensearch.search.aggregations.metrics.Stats; /** * Statistics over a set of buckets + * + * @opensearch.internal */ public interface StatsBucket extends Stats { diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregationBuilder.java index 1cb0f844eb7..196b13ed35c 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregationBuilder.java @@ -39,6 +39,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for stats_bucket agg + * + * @opensearch.internal + */ public class StatsBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder { public static final String NAME = "stats_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregator.java index aa0f4a645fa..577f66f94e9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/StatsBucketPipelineAggregator.java @@ -40,6 +40,11 @@ import org.opensearch.search.aggregations.pipeline.BucketHelpers.GapPolicy; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a stats bucket + * + * @opensearch.internal + */ public class StatsBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private double sum = 0; private long count = 0; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregationBuilder.java index e7cd3ae4f2a..90e09cd7131 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregationBuilder.java @@ -39,6 +39,11 @@ import org.opensearch.common.xcontent.XContentBuilder; import java.io.IOException; import java.util.Map; +/** + * Aggregation Builder for sum_bucket agg + * + * @opensearch.internal + */ public class SumBucketPipelineAggregationBuilder extends BucketMetricsPipelineAggregationBuilder { public static final String NAME = "sum_bucket"; diff --git a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregator.java index baf1fdecfc3..32a64fafa7a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/pipeline/SumBucketPipelineAggregator.java @@ -40,6 +40,11 @@ import org.opensearch.search.aggregations.pipeline.BucketHelpers.GapPolicy; import java.io.IOException; import java.util.Map; +/** + * Aggregate all docs into a sum bucket + * + * @opensearch.internal + */ public class SumBucketPipelineAggregator extends BucketMetricsPipelineAggregator { private double sum = 0; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInfo.java b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInfo.java index 47ade916380..c2983945d5a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInfo.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInfo.java @@ -46,6 +46,11 @@ import java.util.TreeMap; import java.util.TreeSet; import java.util.concurrent.atomic.LongAdder; +/** + * Data describing an agg + * + * @opensearch.internal + */ public class AggregationInfo implements ReportingService.Info { private final Map> aggs; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInspectionHelper.java b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInspectionHelper.java index aca4cb8c362..8d036503d13 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInspectionHelper.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationInspectionHelper.java @@ -88,6 +88,8 @@ import java.util.stream.StreamSupport; * or because of summing to zero). Pipeline aggs in particular are not well supported * by these helpers since most share InternalSimpleValue and it's not clear which pipeline * generated the value. + * + * @opensearch.internal */ public class AggregationInspectionHelper { public static , B extends InternalTerms.Bucket> boolean hasValue(InternalTerms agg) { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationPath.java b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationPath.java index 98cd9e66d9e..d93d8049331 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationPath.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationPath.java @@ -74,6 +74,8 @@ import java.util.List; * * * + * + * @opensearch.internal */ public class AggregationPath { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationUsageService.java b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationUsageService.java index 8b6124cd9cc..f9b6a914448 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/AggregationUsageService.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/AggregationUsageService.java @@ -38,6 +38,11 @@ import java.util.HashMap; import java.util.Map; import java.util.concurrent.atomic.LongAdder; +/** + * Service to track telemetry about aggregations + * + * @opensearch.internal + */ public class AggregationUsageService implements ReportingService { private final Map> aggs; private final AggregationInfo info; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java b/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java index c75ab861439..8527eaae2ec 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java @@ -30,6 +30,8 @@ import java.util.Objects; /** * A configuration that tells aggregation how to retrieve data from index * in order to run a specific aggregation. + * + * @opensearch.internal */ public abstract class BaseMultiValuesSourceFieldConfig implements Writeable, ToXContentObject { private final String fieldName; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/CoreValuesSourceType.java b/server/src/main/java/org/opensearch/search/aggregations/support/CoreValuesSourceType.java index 650b554efc1..209b996cc5e 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/CoreValuesSourceType.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/CoreValuesSourceType.java @@ -61,6 +61,8 @@ import java.util.function.LongSupplier; /** * {@link CoreValuesSourceType} holds the {@link ValuesSourceType} implementations for the core aggregations package. + * + * @opensearch.internal */ public enum CoreValuesSourceType implements ValuesSourceType { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/FieldContext.java b/server/src/main/java/org/opensearch/search/aggregations/support/FieldContext.java index 451afb559c0..a6207917d52 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/FieldContext.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/FieldContext.java @@ -37,6 +37,8 @@ import org.opensearch.index.mapper.MappedFieldType; /** * Used by all field data based aggregators. This determine the context of the field data the aggregators are operating * in. It holds both the field names and the index field datas that are associated with them. + * + * @opensearch.internal */ public class FieldContext { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MissingValues.java b/server/src/main/java/org/opensearch/search/aggregations/support/MissingValues.java index 3bb14324058..6e0778f9a0a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MissingValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MissingValues.java @@ -49,6 +49,8 @@ import java.util.function.LongUnaryOperator; /** * Utility class that allows to return views of {@link ValuesSource}s that * replace the missing value with a configured value. + * + * @opensearch.internal */ public enum MissingValues { ; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java index 3bc7f444c61..def1191c70f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java @@ -25,6 +25,8 @@ import java.util.Objects; /** * A configuration that used by multi_terms aggregations. + * + * @opensearch.internal */ public class MultiTermsValuesSourceConfig extends BaseMultiValuesSourceFieldConfig { private final ValueType userValueTypeHint; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSource.java index ecc03b046e4..3ef949c6eeb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSource.java @@ -43,6 +43,8 @@ import java.util.Objects; /** * Class to encapsulate a set of ValuesSource objects labeled by field name + * + * @opensearch.internal */ public abstract class MultiValuesSource { protected Map values; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregationBuilder.java index 72d508de1d1..7573f69e083 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregationBuilder.java @@ -53,6 +53,8 @@ import java.util.Objects; * can pull values from multiple fields). * * A limitation of this class is that all the ValuesSource's being refereenced must be of the same type. + * + * @opensearch.internal */ public abstract class MultiValuesSourceAggregationBuilder> extends AbstractAggregationBuilder { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregatorFactory.java index 0ce8e3ea9b5..499fa41096d 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceAggregatorFactory.java @@ -43,6 +43,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base class for MultiValuesSource aggregator factories + * + * @opensearch.internal + */ public abstract class MultiValuesSourceAggregatorFactory extends AggregatorFactory { protected final Map configs; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceFieldConfig.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceFieldConfig.java index ea9bbe80192..a7145ac8713 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceFieldConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceFieldConfig.java @@ -48,6 +48,11 @@ import java.io.IOException; import java.time.ZoneId; import java.util.Objects; +/** + * Base field configuration class for multi values + * + * @opensearch.internal + */ public class MultiValuesSourceFieldConfig extends BaseMultiValuesSourceFieldConfig { private final QueryBuilder filter; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceParseHelper.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceParseHelper.java index 82054ab53af..e51465fb930 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceParseHelper.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSourceParseHelper.java @@ -38,6 +38,11 @@ import org.opensearch.common.xcontent.AbstractObjectParser; import org.opensearch.common.xcontent.ObjectParser; import org.opensearch.common.xcontent.XContentParser; +/** + * Helper class to parse multi values sources + * + * @opensearch.internal + */ public final class MultiValuesSourceParseHelper { public static void declareCommon( diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValueType.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValueType.java index 5912a01664e..e55b78e61d9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValueType.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValueType.java @@ -44,6 +44,11 @@ import java.time.ZoneOffset; import java.util.Arrays; import java.util.List; +/** + * Enum to signal what kind of value type is used in the aggregator + * + * @opensearch.internal + */ public enum ValueType implements Writeable { STRING((byte) 1, "string", "string", CoreValuesSourceType.BYTES, DocValueFormat.RAW), diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSource.java index a0875737f37..9bcf7df85d0 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSource.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSource.java @@ -69,6 +69,11 @@ import java.io.IOException; import java.util.function.Function; import java.util.function.LongUnaryOperator; +/** + * Base class for a ValuesSource; the primitive data for an agg + * + * @opensearch.internal + */ public abstract class ValuesSource { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregationBuilder.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregationBuilder.java index 70c36be06a9..5eb880642b9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregationBuilder.java @@ -54,6 +54,11 @@ import java.time.ZoneOffset; import java.util.Map; import java.util.Objects; +/** + * Base class for all values source agg builders + * + * @opensearch.internal + */ public abstract class ValuesSourceAggregationBuilder> extends AbstractAggregationBuilder { public static void declareFields( diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregatorFactory.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregatorFactory.java index 14d0aa72535..69a4a5d8b67 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregatorFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregatorFactory.java @@ -42,6 +42,11 @@ import org.opensearch.search.internal.SearchContext; import java.io.IOException; import java.util.Map; +/** + * Base class for all values source agg factories + * + * @opensearch.internal + */ public abstract class ValuesSourceAggregatorFactory extends AggregatorFactory { protected ValuesSourceConfig config; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceConfig.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceConfig.java index 623b88c595c..e956dd054eb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceConfig.java @@ -49,6 +49,8 @@ import java.util.function.LongSupplier; /** * A configuration that tells aggregations how to retrieve data from the index * in order to run a specific aggregation. + * + * @opensearch.internal */ public class ValuesSourceConfig { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceRegistry.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceRegistry.java index c1518491b09..430accde5c2 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceRegistry.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceRegistry.java @@ -49,6 +49,7 @@ import java.util.stream.Collectors; * directly instantiate this class, instead get an already-configured copy from {@link QueryShardContext#getValuesSourceRegistry()}, or (in * the case of some test scenarios only) directly from {@link SearchModule#getValuesSourceRegistry()} * + * @opensearch.internal */ public class ValuesSourceRegistry { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceType.java b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceType.java index 6f7a9ec0cc9..86102e63297 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceType.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/ValuesSourceType.java @@ -57,6 +57,8 @@ import java.util.function.LongSupplier; * if logically the type needs a more restricted use (e.g. even though dates are stored as numbers, it doesn't make sense to pass them to * a sum aggregation). When adding a new ValuesSourceType, new aggregators should be added and registered at the same time, to add support * for the new type to existing aggregations, as appropriate. + * + * @opensearch.internal */ public interface ValuesSourceType { /** diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptBytesValues.java b/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptBytesValues.java index 327437aa2ba..e53d9b83a81 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptBytesValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptBytesValues.java @@ -44,6 +44,8 @@ import java.util.Collection; /** * {@link SortedBinaryDocValues} implementation that reads values from a script. + * + * @opensearch.internal */ public class ScriptBytesValues extends SortingBinaryDocValues implements ScorerAware { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptDoubleValues.java b/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptDoubleValues.java index ab9a36037c6..22d6fc707be 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptDoubleValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptDoubleValues.java @@ -46,6 +46,8 @@ import java.util.Collection; /** * {@link SortingNumericDoubleValues} implementation which is based on a script + * + * @opensearch.internal */ public class ScriptDoubleValues extends SortingNumericDoubleValues implements ScorerAware { diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptLongValues.java b/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptLongValues.java index 67a55383d10..a14f6165b9a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptLongValues.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/values/ScriptLongValues.java @@ -48,6 +48,8 @@ import java.util.Iterator; /** * {@link LongValues} implementation which is based on a script + * + * @opensearch.internal */ public class ScriptLongValues extends AbstractSortingNumericDocValues implements ScorerAware { diff --git a/server/src/main/java/org/opensearch/search/builder/PointInTimeBuilder.java b/server/src/main/java/org/opensearch/search/builder/PointInTimeBuilder.java index 3cfd673d28c..520ce124a19 100644 --- a/server/src/main/java/org/opensearch/search/builder/PointInTimeBuilder.java +++ b/server/src/main/java/org/opensearch/search/builder/PointInTimeBuilder.java @@ -49,6 +49,8 @@ import java.util.Objects; /** * A search request with a point in time will execute using the reader contexts associated with that point time * instead of the latest reader contexts. + * + * @opensearch.internal */ public final class PointInTimeBuilder implements Writeable, ToXContentObject { private static final ParseField ID_FIELD = new ParseField("id"); diff --git a/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilder.java b/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilder.java index 8c162e1fa4a..88281b12f47 100644 --- a/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilder.java @@ -89,6 +89,8 @@ import static org.opensearch.search.internal.SearchContext.TRACK_TOTAL_HITS_DISA * {@link org.opensearch.search.builder.SearchSourceBuilder#searchSource()}. * * @see org.opensearch.action.search.SearchRequest#source(SearchSourceBuilder) + * + * @opensearch.internal */ public final class SearchSourceBuilder implements Writeable, ToXContentObject, Rewriteable { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(SearchSourceBuilder.class); diff --git a/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilderException.java b/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilderException.java index 700950cdf89..a884e5d1be8 100644 --- a/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilderException.java +++ b/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilderException.java @@ -37,6 +37,11 @@ import org.opensearch.common.io.stream.StreamInput; import java.io.IOException; +/** + * Error thrown on source builders during search phase + * + * @opensearch.internal + */ public class SearchSourceBuilderException extends OpenSearchException { public SearchSourceBuilderException(String msg) { diff --git a/server/src/main/java/org/opensearch/search/collapse/CollapseBuilder.java b/server/src/main/java/org/opensearch/search/collapse/CollapseBuilder.java index e4064eed55f..be4d73349a3 100644 --- a/server/src/main/java/org/opensearch/search/collapse/CollapseBuilder.java +++ b/server/src/main/java/org/opensearch/search/collapse/CollapseBuilder.java @@ -56,6 +56,8 @@ import java.util.Objects; /** * A builder that enables field collapsing on search request. + * + * @opensearch.internal */ public class CollapseBuilder implements Writeable, ToXContentObject { public static final ParseField FIELD_FIELD = new ParseField("field"); diff --git a/server/src/main/java/org/opensearch/search/collapse/CollapseContext.java b/server/src/main/java/org/opensearch/search/collapse/CollapseContext.java index 75f340de4dd..09a612a15d7 100644 --- a/server/src/main/java/org/opensearch/search/collapse/CollapseContext.java +++ b/server/src/main/java/org/opensearch/search/collapse/CollapseContext.java @@ -42,6 +42,8 @@ import java.util.List; /** * Context used for field collapsing + * + * @opensearch.internal */ public class CollapseContext { private final String fieldName;