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 8b5bbc9f28d8f..5863bf66f59f8 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 @@ /** * 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 6c4a4ce8dd664..66c3ec0477198 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 @@ /** * 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 1e372aff17cd4..5c76f0cc091c3 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 @@ /** * 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 99a1107675edf..bccf0afc0f3ed 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilders.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilders.java @@ -108,6 +108,8 @@ /** * 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 5bb65bc33fcde..989783b11da3c 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 @@ /** * 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 c73cd7670b3fd..87fcfece07064 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 @@ /** * 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 be62b33adb356..3503efcdb4df3 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationPhase.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationPhase.java @@ -48,6 +48,8 @@ /** * 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 9360f03304cf2..4049d96d68817 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 @@ /** * 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 b38dfe123fdf4..99a54bbdc27b0 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 @@ *

* 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 09af84bc81144..db51f00056f72 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 @@ /** * 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 1dde4c782c9dc..ec536578f7251 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 @@ /** * 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 65f44c8a34669..05686f35c2166 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 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 24b34c2c111c0..2232367b16c51 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 @@ /** * 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 e84f4d19e8080..5db683252a033 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 @@ /** * 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 423c143e6aaea..6dc8c9a61d864 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 @@ * "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 984c8a0872903..7596cf471c4a3 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 @@ /** * 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 92b4d3f69bb6f..6d3c599eee05c 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 7c403bcb9dbbf..55c400218b06b 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 @@ /** * 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 371a2b04ae019..fb8fb18598dac 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 @@ /** * 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 983f2cbe21ae1..b519334e6f92e 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.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 923650fbeac3f..491e08bc847d1 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 @@ /** * 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 011206ddd049d..1222e3904ea5e 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 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 1e64ad8992a27..5acf32183a810 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 @@ * * @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 0d29469f12d97..6694ba3e0a34d 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 @@ /** * 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 2da9f4307c40a..5b5f2b7a6f8cb 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 @@ * 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 6bb044b1d7ea8..80c7b37624fa5 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 @@ * {@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 ce9527e812db5..d7c1796b1715f 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 @@ * 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 92a37b726469b..34d1d48d8ce21 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 @@ /** * 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 64d2779dceb61..5d4803cd1ebca 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 @@ /** * 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 67310bc2a5ae2..6258295a2b733 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 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 3652f46350985..6aba50ec912d8 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 @@ /** * 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 3e8d3325fd604..b025860b9e65b 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 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 229f6bf118f61..f51d5af23b049 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 @@ /** * 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 48e674d977231..f3addc9522a94 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 @@ * 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 6dd064a501087..9a4f19910b36c 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 @@ /** * 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 f18f6fb83816d..9e35a2745fc90 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.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 8efbad76b82cd..1ff065f39f359 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.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 8bb5074acbaad..d11fcfd104af1 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 @@ /** * 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 bba1e526f6985..e47053e7501e7 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 @@ /** * 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 e0e14640d83f7..470fc0bc05389 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 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 4edb13dbba676..8d35c1edc8cb0 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 @@ * 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 437fc8a372d1c..5bd014c6e4df0 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 @@ /** * 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 ddbbb3ed4f830..373099b367c03 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 @@ /** * 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 b6e5acc39fee1..af0babcc1c22f 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 @@ /** * 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 b6b51f707ceba..268e5f2aaf90d 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 @@ /** * 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 4bf071aa23bf9..5cb8af37323e5 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 @@ * 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 640cceacb197d..0eebd3e0bf3d6 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.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 b1054a01448f5..1cae870a378a5 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 @@ /** * 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 7fffcff7b5db2..fe1270e10c80e 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.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 99a62621946e4..52a8d638d8e1d 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.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 27e0bf40ca017..f211c072cbd1f 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.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 44a29e2251b13..54fd261f88c35 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 @@ /** * 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 e245aefcbbcc4..06ec7f8b1baf7 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.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 0dfc1de3503e8..8b07df3f689bf 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 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 d7383285ddd1c..09691a69c75f4 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 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 6af887201d994..94fc48708c41f 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 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 cb2801e625bfb..94b32c8c02ff0 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 @@ /** * 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 a7963532235ec..ac50869b5d79b 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 @@ /** * 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 9ac43c812e41c..7764d367a0cec 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 @@ /** * 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 bcde67023b1ff..c85099976b297 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 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 c1e64f57c10cc..60d7f277f7650 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 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 acab1790bfa21..ece8f506cbc4d 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 @@ /** * 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 fb94ff194b950..d05c78f540641 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 @@ /** * 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 5d47a44a26222..d4252d132ee12 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.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 2daddc9647f44..819dfc573bbe4 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 @@ * * 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 b4db4d8dd2a36..3e5c53d470f79 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 @@ /** * 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 59625bc3300e5..d993578f757ad 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 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 1f1ed3b6254ba..f087d2d0495dc 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 @@ /** * 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 c102095d93184..8b28c1a7c5ae4 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.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 0ce147a138a96..a7ed50507288d 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 @@ /** * 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 5cbda5dca130a..965dc42a1e011 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.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 8dbb902b96186..3d6730203b6ae 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 @@ /** * 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 fc0dfe9a5a098..3c710a6e1d525 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 @@ /** * 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 94b108e863e3d..747a7017ec872 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 @@ /** * 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 9fe92c5f8d7fa..3cdbee6b119ec 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 @@ * 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 c977ba3c7ecdb..89e7f4fae1321 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 @@ /** * 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 c871e8d0c7d5b..ea1fc88e5cc32 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 @@ /** * 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 44ccea1204fdb..213e76f19c535 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 @@ /** * 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 58c47fa3e5c5b..b1d829c33423b 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 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 28bfb6071332c..0f73d3453b658 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 @@ /** * 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 07823f19e34b5..4ab573cf0a6b6 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 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 b70cbd2586ebc..25153eb86d1d8 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 @@ /** * 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 a1a5d53bf2b30..cb491083fbf25 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 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 e13a3c7557685..1b58d5372c5bf 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.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 50125c4cc50b0..8741213f98811 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.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 fc408366a8333..e3cf61a4ef816 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 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 3989400bb4958..ba7cb41f63abb 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.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 1d922949d9983..b31df2cb178a2 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 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 bcecac0ac0350..0ac821b6c8a11 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 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 cc4f5835cabf1..ba824fc8f21dd 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 @@ * 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 3a8245a52adfc..d6cfde0c46eae 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 @@ 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 c9ea7696cd7f5..bf47fe218073b 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 @@ /** * 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 2e8344f203a39..9dc357659aae8 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 @@ * 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 7521f9f58bd96..cfdb08f9ee3d7 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 @@ /** * 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 5ec17c951d183..c235626e09a10 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.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 7eb05adf78e45..1ef8ba6c697f4 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 @@ /** * 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 a1ae76eb034d0..4049bf2c73640 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 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 74c8170458734..1106320c7431f 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 @@ /** * 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 a52ee2018fdfe..cdc801aaedffb 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 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 6828077cd4778..f73360e3cb826 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 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 390f613686272..7a2b908148c4c 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 @@ /** * 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 616451474abc4..ef8cd11a22498 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.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 d520cc995bbfb..5498b2b1a7109 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 @@ * 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 e7fed7c735b25..94a5ad5717854 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 @@ * 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 0ddfed84fbe99..a187bfefb661f 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 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 bae4f99d3bb5b..7811b8774d04f 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 @@ * 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 a5bead1f17280..f9c45dc41ceb1 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 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 d7ff2c0a2cd33..efbd9a05d6a4d 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 @@ * 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 b08ef55a71f5b..f200f55232e00 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 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 59681a52b1c01..3f85cf350c89c 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.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 f09eb46fd8a48..08e5c15188ee6 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 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 189bfb4b58c92..f20f972c1ce0a 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 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 3ed6cfe41ba77..05c7a1c8d1663 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 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 011fe2c9102c7..06915cc4210e1 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 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 5b2bdd163d8f2..c8dec16f322ef 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 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 7dd7f155fb46e..f5a139cdb8d9d 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 @@ /** * 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 4a5a484ea7565..9481d134adcb5 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 @@ /** * 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 ad3498043c538..2e8105b569afe 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 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 7b3c9399225ae..96cf8f8f7664a 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 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 102e1befb0822..419ae9f16d9e6 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 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 20f49e4ce00df..68e4f1d4e2c10 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 @@ /** * 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 2e97e76ad3e28..ae96e509b3998 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 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 adf3d973a2621..d3a4a51e5b6f2 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 @@ /** * 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 a9f5339ad4fdb..9321617174400 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.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 76812334ff235..587e838568046 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 @@ * 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 3cb2a3a7d0962..7434ef84ee92f 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.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 fe48c4ba95307..a9b62019bdeb5 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.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 c416f6657b9ea..f8952ddca4cc3 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 @@ /** * 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 dab69e86e4173..146eeedfbe933 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 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 d243c46a7a136..295dfec639de6 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 @@ * {@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 900262aaa10a2..eb22a857643c4 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 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 f3d3a56785931..c5ef4e7a075f5 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 @@ /** * 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 79581fd31375c..a2c63cf25c0c2 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 @@ * * 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 fb1287ac1716c..6c187f7924a19 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 @@ * 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 d81ac0ae44ac8..f70a5bb537300 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 @@ * {@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 a822976517910..c2e44c55c3950 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 @@ * * 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 85c53243f41a4..0d9eb9b82dd34 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 @@ /** * 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 1ca2988a3e7c0..ceb7709907057 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 @@ /** * 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 4978998e0824b..722bf87201631 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 @@ /** * 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 68af0b10c122d..4462605209775 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 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 d5566f540b5d2..4488b5bd2206e 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 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 83cd22934ab87..55ef48211bcb4 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 @@ /** * 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 9f26242e203a9..068d6533c59b3 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 @@ /** * 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 98e1aadd8c100..c11f483392c25 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 @@ /** * 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 5a103771356d3..ec4be47e4a62f 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.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 5e8087ef53e0e..ad287a158dba3 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 @@ * * 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 e6cddafc086a7..1cd44be431964 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 @@ * {@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 671f2700ace36..83f776d34a17e 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.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 efb681130ee66..248f41f213031 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.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 354c95efa98f9..1cc7865d22f45 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 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 727e34d3e7608..c03221af74c15 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 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 919815c988fcc..fe77033f5a287 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.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 21b085e297322..cfa154a6e9018 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 @@ /** * 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 9edb76443f9a4..a87de32d0e18b 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 @@ /** * 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 169d219e76c42..55b3903efa349 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.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 2dc9d50e10015..11ff7dbc407cb 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.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 644c41cc6f534..d9d9a74eb958f 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 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 80936ef0c27dc..153d7f1df7b41 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 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 3f2a4197680e8..9918ae1f4b384 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 @@ /** * 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 75a74a02d3d4d..b322b13bb33a0 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 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 f189c3cf5e111..5f7b4b5a91e44 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 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 37b3f784e8715..cfa2bd3f7097c 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 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 6b273514bb649..f9d99b1c7223a 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 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 06086f507f665..b0b987065c647 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 @@ /** * 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 1a4a88e69754f..81a57818a0d0a 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 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 a90134ebb8756..c3346c66d1733 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 @@ /** * 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 1754a856b7a26..95b4714bdba9b 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 @@ /** * 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 9e3775bb095a9..e5d52e9e01e5b 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 @@ /** * 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 385ce67ffefa7..b99336de16997 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.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 a003f1380253b..dc536aebc0cde 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 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 0102d1724351c..22b87280c8534 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 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 01e7593ecb95c..abf069c662d3c 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 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 66a789f4c35d2..cd0cf8cb97106 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 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 871c185d50210..1bc2383573e6c 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 @@ /** * 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 72854b36f2167..42105ebc71af0 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.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 689304215e9c7..0513e9235e3b0 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 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 202645c8638ab..2929df697ea58 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 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 973ef10881e68..90ae2e994caf1 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 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 083d80bba4efe..b6d709d319698 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.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 c4b4728db5364..c846ba6c48b20 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 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 d1cadb9b9ec99..0ee440ecc8487 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.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 bf0d012be55bb..76b9370be4626 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.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 c9d9eb39ff9ba..d243a89c632d7 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 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 8e332cfd4a63a..701f46719b8e3 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.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 430cbf4176c55..c4a9efda18bda 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 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 ba054357b4af2..cd8179f00a842 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 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 506593113a0f8..95e04d3f47e7e 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 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 6becf1f692cb2..8ce01370ad160 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.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 6b3a19e1113e3..0cbe572e31917 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.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 ff61a0fd87e58..8da0d132fd54f 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.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 1a691a074a5e2..843733d736bc0 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.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 e3de71a9b3cda..5efe9d952911b 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.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 13f52759ea1a1..68f8aae9aefb9 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 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 a388fdd3d20be..889b57b1a128c 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.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 1877a951f38b1..86fa2555c727c 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 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 ea7f4456bbdce..0ad192636c0a7 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 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 55619acf233a3..0a979a9a1625b 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 @@ /** * 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 c50bcc1b61493..649f4e6dbb781 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 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 9786bc63405b5..4d2b0437adb08 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 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 b2a1b1046aaa2..803bceaf57fb5 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 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 ecc6c6cde442d..de9b979a56107 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 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 42ef44e642d4e..080142185f82e 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 @@ * {@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 dc1ddddaa4721..1fc31f8ffe0ae 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.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 f7b43a0da2337..f8d3040620a51 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 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 9992a18aa13ea..8f8b4f970ee84 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 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 c0b3536838430..555e45460b844 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 @@ /** * 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 fdb00eed24c0d..cb880759887e4 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.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 8b4bed89e678c..472cc1beb82f8 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.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 62caa017eddba..953a45971919c 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.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 593c3c50ee19d..8b6f4d32bed3c 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 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 6c4fe2927d7bd..005a6a40a4640 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 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 45fbf6913fd04..a9c2a76a69b85 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 @@ * 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 42aebe384f0f9..09c4ad0bb3384 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.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 a7855c2b400f1..fd1d7bf2997ac 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 @@ * 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 35e3a618dfad3..fa98c799352a6 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 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 620a6e02c2b9a..a8abbb3e65dff 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.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 5820652b179d2..6ca66b38408a0 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.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 9e83891067237..9551be10e52b8 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 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 258a6c43c49ab..29314c08cfab9 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 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 7a112135567b9..25e016fb77c9f 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 @@ 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 1cdf4f509537b..7bfeff7615b83 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 @@ /** * 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 c556dd1144b24..7f2765657781a 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 @@ /** * 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 40b43d11c5b3b..4be90ac2f9b7a 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 @@ /** * 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 f32abd1892592..4464e4eb54760 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 @@ /** * 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 7086fb4cba7d3..1d8e47b0d3ea7 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.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 ab47a220a6524..d72162c81e00e 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.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 5070b6e8fefec..c38dd55fdfd9a 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 @@ /** * 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/InternalRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalRareTerms.java index 8f51ede1bc2a7..441a0783536d5 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.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 4122e8b26e348..80fd4e2f5dc7a 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 @@ /** * 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 be397bcbb2f2c..df446bec44e98 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 @@ -61,6 +61,11 @@ 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.Bucket> 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 0964d8aa8adb7..d60c774adaa3c 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 @@ /** * 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 f8ea5c4231cac..f65401f913a89 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 @@ /** * 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 1a44c41c1f15f..6e4cd895e7496 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 @@ /** * 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 265fa532574be..2a92749943256 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 @@ /** * 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 a1c7d22bd29e0..2450a5a3692e1 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 @@ /** * 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/NumericTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/NumericTermsAggregator.java index 4ea341caa0fed..2c4c502b86695 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 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 5be42312656f2..2ace6b637e6df 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 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 e84c00519acd8..c66f3cd676893 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 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 f75d1695819a0..45f51854aa603 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 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/ParsedRareTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedRareTerms.java index a9fcd6e0277e6..f195028244913 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.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 1488588a6847a..23c29b2745f73 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 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 961e4881f1eb8..ce508687aed6c 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 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 b57635a50d2d9..1d6b64f3dcd0b 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.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 65a3090bee827..ecf5bd84097b0 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.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 faf34c6da5fec..c849d6c8c8840 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 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 ce5f56c898fa6..095afc667414b 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 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 4e9c9be2cd255..6e26503c149c5 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 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 2b419d1a45219..64436e1b2fb16 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.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 ed70a9b310ea1..b689865ac8c99 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.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 7fe05adc7c610..5f8888e2819c2 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 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 3911352568356..aee4caa67afa1 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 @@ /** * 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 1aebdc663737e..6e2b48f55796e 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 @@ /** * 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 9c0f075ea5b22..3795df964b0c4 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 @@ /** * 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 299a6d29f1b85..a5d1c29b0ee0a 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 @@ /** * 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 3c9c5797fff7a..c50436b6223b7 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 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 8935c9715a1e0..ff35d128ef524 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.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 2d07527d61ede..a1fa7ab9d061e 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 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 bdfcf0e27fa58..7be04b13f0d6b 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.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 9085df1ccd749..a509cbfd49ffd 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.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 58473c715563c..f6a925c5340a1 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.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 b4093a73f7305..c796faa6a8b76 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 @@ /** * 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 3e70428472c37..829ec07c91087 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 @@ /** * 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 e6cb64928c0d8..df2028c81b1eb 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 @@ /** * 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 11a51f51d53c1..ae1c2bff2c327 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.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 a5ee44ffa222e..d60d1609ae9d4 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.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 b320126dff24b..abbd7945bdde4 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.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 a9b319378937d..27e5adf031483 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 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 ef759cf4e7475..279bbf95641e0 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 @@ /** * 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 a99f013327a88..535a6b58059a5 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 @@ /** * 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 ad499aed451d1..9b792720b492a 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 @@ /** * 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 3083fa2b86814..1597976986beb 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 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 4e88ad992bde0..4f315836d9b3c 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 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 b3cc463f71e1b..1b36947f72d02 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.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 3114aa940f2ef..761e1cf31da10 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 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 a194765209a40..e385bea5a7c11 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 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 fa80ba67a7b5a..5e976d0fd67b4 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 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 eeebdabda45fb..65f3ec4bd752d 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 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 b63cc483e58aa..7644c84bf2282 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 @@ /** * 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 b824652bdbe08..576247b0989fc 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 @@ 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 8851313f61e5a..a8a7b513d01e5 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 @@ /** * 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 abf63ee0b73e6..a0d86b382eef0 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 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 8008d70f664a6..89b77eb840dd2 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 @@ * 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 75d9dea7ef86a..4ea9c48e360ef 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 @@ * 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 0dc2803d5f6c3..568305cf6ff2c 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.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 5ac87df3e139c..5b881da804146 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.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 71a97e1456fab..3b607b3a86784 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 @@ * 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 ac0baf18dfb55..a580d17099ec2 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 @@ * 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 80bfcb55f7391..8c79a80a26b9e 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 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 0c662423b2407..4deffd60f28d8 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 @@ /** * 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 8fd3febc4d2a9..96a131117c34c 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 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 24cebdf289790..e58466b56df2a 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 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 696d65ec9d8aa..727304f8a5254 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 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 749c2554cf479..dab281aa7ec6f 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 @@ /** * 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 12771f06e3192..8cb5e80597a20 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.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 61cb08ba28ab0..1c1530843a66a 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 @@ /** * 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 944cc4dc90771..47084436d3d4f 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 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 8ecd0fba9158a..d5cb0242762fd 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 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 0cf637885cfa2..151b0d5073909 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 @@ * 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 ed8ffc1e19e36..36e9c1f93866c 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 @@ /** * 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 cc01cba7c2a4a..649650b5a8d0b 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.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 b973f2cb74213..203fcd30b6300 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 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 f08d9630e8692..20203b22b2459 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.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 ac86ebc2fc8aa..88cdf60b7aebe 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 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 ba0e115c383dc..380fbce85ada7 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 @@ /** * 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 30ba6988325e6..64e27fa7e13d1 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.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 6d3b0796ac520..054e8d4cb1c6c 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 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 27744a549c748..2c6b75842b6f5 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 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 38e2fc919cf5e..4fd2b7be494ea 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 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 69f835e54ff0a..a5c13d15bacce 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 @@ /** * 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 dff3950fbe97b..b8c0b9ad1b2e9 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 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 a8e8907b61ccf..656211608433a 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 @@ /** * 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 d8ad21d532522..1d450eeae98d8 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 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 3c29c3558eb35..183c64f4e4af2 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 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 959f0f82da4b8..8dea6c3a4b649 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 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 83c6cf051cbd1..e8b1e73db689e 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 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 3408e8cf3bb5f..bfc121627bfe7 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 @@ * 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 1a7a544d26bc9..9a042726423e7 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 @@ * * 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 ddbae8b37b33f..0dff1c7a9c2ab 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.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 234e20393fa98..b4105084560f8 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.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 34d87d92dbbdb..75a4dbb4e74dd 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.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 84a46ed6c71d6..87018242ee8df 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.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 c043cca5d6c6f..262f8cc890192 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 @@ /** * 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 eb11d4bda33e3..ba3c917d1b5e6 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.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 2ba910fee43c9..2b1da6387494b 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.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 675f82eda8add..6c9dcb29e2355 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.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 9066709b8bfaa..864894f7547ee 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.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 ba00bc457ff83..8f28a714ba840 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.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 e7c43794d3963..2c66321ecb331 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.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 a9924916de1de..9244d661a699e 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 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 6c6953633c799..6bd48f221346b 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.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 174b697839659..0a89b5ed3d1a3 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.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 65d3ece0bbb40..45ce6dc3ead3a 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.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 1988d03ca5e4b..8cc224f2f08ec 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.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 24e7875a6ade9..0f17c6c9180eb 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 @@ /** * 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 7e839a6874ee1..0f7aff1a674c8 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 @@ /** * 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 6e2cf0dc6d326..b2855f8bd15ac 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.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 24a0c834b597d..5834173e10ea5 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 @@ /** * 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 4cdc73a08dd20..55c5a6ca3ce42 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 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 b755d54de0fe5..8108b8a726856 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.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 2541f8fdf0bbb..3ec24ad04d9aa 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 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 34437b7c91621..0c989f627309d 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 @@ * 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 09faa958f821c..e6a8de6b4edc2 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.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 24c26d695c715..0b4684452a8dc 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 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 e749fe4db0866..9776595d5a76d 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 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 6ae211719217b..986e32cf438cd 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 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 f260da8a2638c..4e70d417c4b91 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 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 2ed48a97bc381..47e27da5394b3 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 @@ * 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 f59daeb469009..0929fc60b02c9 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 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 dd3aea059e826..b99e08c9df86c 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 @@ /** * 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 89797710a40f7..45c69363bce6a 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 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 372fd936fa766..946057e42ac88 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.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 3db64aa05bb6c..1b24b88d6f068 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 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 acde7bc6f3d4e..88e292f4d4bd3 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 @@ 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 9a4c0be0b7c47..96d2d525e8386 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 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 1242f61e75ac8..cc12044cba09d 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 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 99bb36b900c23..4c6e3f7c78877 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 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 1cc0ab59030db..0378ffff9980d 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 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 e0c734e4dc8c5..a482fcfdf08dd 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.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 06e099f9709ea..04feb4a96dd56 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 @@ /** * 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 5faa795d8b630..e3c4ac5d3a4ab 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 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 f7a4afb86be3e..3a2f510ebb4e3 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 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 2862a629ab747..ae91e4a3873cf 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 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 001e44736ae2a..9e2dc3025450f 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 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 711a4e94b0e7a..f5d571b58e45c 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 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 71773e80405e9..be57e85962e8d 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 06f8eba1f46ff..f6efeed0b96cb 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.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 b7bc5a7d2c39c..afd89bb9f9ef6 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.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 ae657e203fc2f..ebcf34b77facb 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.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 55258f1e10973..0c83417a82604 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.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 2f5d8fca16636..73024e26128a3 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 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 f1cfaf3f08848..c7cf92f6a0873 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 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 9b6090c3de2e3..36531ad7e699a 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 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 9d52e71cbfe6b..b0c5709c9bab0 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 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 305cee740648c..0e3f8f5633174 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 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 680f6274c8e21..f67fd13a8ccd4 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 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 d797e602b2d80..50ebd6f343fc2 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 @@ 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 00725b20f8015..b4a6dc39a442e 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 @@ /** * 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 037830c63ecdf..e63830fa7edac 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 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 059b9dd7d0d1c..19352d30a5177 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.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 5b40a2ce8f2f3..f6bf9d1f82348 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 @@ /** * 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 323723bb6deb1..ef80e86661ce0 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.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 15f3010719916..e249863e25313 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 @@ /** * 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 d65619be5bc0e..8f6e36a3ac8e1 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 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 26ef2727832bc..f20cf2eb22350 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 @@ * 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 b167251861bc2..ee7b745382632 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 @@ /** * 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 3cf6da01e0f43..487e7c9de22d6 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 @@ /** * 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 4564977f09471..7a2b733a67d5d 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 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 8ff0e33afbcf9..2a2943e93150f 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 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 53e865b2f04b7..7b5848fc79197 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.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 4228996f426df..4e854196f387b 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 @@ /** * 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 da38127c80d2d..9de5e4d9f9b96 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 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 069721e37531f..c52638fe4b9c6 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 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 01772df17a925..6e343ed9a31d1 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 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 cee960280e052..e58a9e504cf04 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 @@ /** * 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 dee421d8bd38a..d6d33eae90c96 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 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 82799d8e9f3a1..4b8e882cd69bc 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 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 c05b438b0680f..c94949bca09e6 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 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 c61a55950b7d2..8c7b71561ed9d 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 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 4c9213f35d10c..a5844858d29c4 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 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 c6ea32d6e9620..e551d0e9d4fa2 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 @@ /** * 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 dc6b02636d627..101af7daafad6 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 @@ /** * 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 d1097aaa20612..f88a47fc745d4 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.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 94425501de3e2..2964ede7979cb 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 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 b9699964a611e..e312983cd6d24 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.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 158c29eca4cbc..8c35a6a7ac72e 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 @@ /** * 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 246609f518547..2a459bb8430c1 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 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 4ba2245e9779e..be98df384fc28 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 @@ * * 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 1542f25dd49c2..feed42e911856 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 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 8afd013f7306e..b81520f8790ca 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 @@ /** * 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 6afad18ddd282..1dccbba0ec54d 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.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 6498674e83847..d85ee651cb5e0 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 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 add0933d40066..9a27e9801d5fe 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 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 290e13b2ee4bc..5d7acc0ec3dc2 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 @@ /** * 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 619d7aa5d4407..e0c1abc304b41 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 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 5aea6e1893c04..e9e1f13a80766 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 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 d73b7a2330041..d7f82f36a3a5e 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 @@ /** * 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 04335c2200e5b..bada4fedceca4 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 @@ 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 b6c78f63687e3..d1de39600ad73 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 @@ /** * 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 239a8e61595a3..f0d7ee4246a29 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.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 5f690725b29ff..4836428027f08 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 @@ /** * 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 9c633ddfa4093..d238791cddaf0 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.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 3c100bae08a95..abf98b6ea4a6f 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 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 b2887ffc7e7a4..929dcd30e5a78 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 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 316dee93f1c55..8f5426eae83a4 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 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 cc780829bf99e..ce9d3150437f5 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 @@ * 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 77058809e719e..809514614b1f2 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.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 fd31bbc6d4abc..80321016867ff 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 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 0903fbf858160..cba35c89cc639 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 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 bbe87f5c27d2d..eb92a78f716dd 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 b5d6f3d20663c..1455c2d6d8780 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.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 6312b479e32f1..3603d1c5a0c58 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 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 6545db9117e2d..1fc86dce35390 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 @@ /** * 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 253901a40d01b..1e74c18e5f82f 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 @@ /** * 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 d9f7765dc515e..aac7e2b0852ea 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 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 1c44a7c7c1caf..746d80d9e58ca 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.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 0c6121217dce5..a63a1da332d08 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 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 51ed0466d0b33..510f3396cf8a6 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 @@ /** * 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 474c91573c528..1dccb17d78b84 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 @@ /** * 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 4e0566250ebd2..4769ef941505a 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.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 81fcbe091768d..2fd5074437c33 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.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 b01b7be6a9c80..26781eba3e0be 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.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 4603d68325513..95028c5a560a5 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.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 e3f505e52b2a2..66bef03622337 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.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 44916c80cab7e..2754376059daf 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.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 0e1ffdbedcfa8..1595c0f5f4514 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 @@ /** * 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 854ea18021bf6..ecf4e59bb8a46 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 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 03bf1c78a8220..1e327919755c7 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.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 96ab48b01c115..ec2b9ab07f562 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 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 137aac02b83cf..2b57aac14ea1e 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.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 b63fee917ce9e..6b7497235efd9 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.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 c369a127c164c..d89abb61db11c 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 @@ /** * 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 298720785f461..5f94c21da395e 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.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 d4ce4170e10b4..2e3c44ac3902d 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 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 56f7ab0c33336..33c09e04bd4b0 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.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 7f1bb8965ed94..70652e7ddce44 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 @@ * - 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 23fcd8b25b342..ff5a4f254e666 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 @@ /** * 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 e3a57654f94cf..bac486576f537 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 @@ /** * 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 7ecbd64d9cff4..e91d31586c092 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.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 0ce2c121f0658..62fac352bb818 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 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 0a518a8363ab6..6be430d49c954 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.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 fe274862c0698..96a877dcda650 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 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 30cffd8fdf48a..a5b9833814cd3 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 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 fc20befbd5c1b..e0731dd9e9c07 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.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 e335dbbaa3ddb..fadc32192a6fb 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 @@ 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 01d30185917f1..bef97bbbaa83a 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.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 02cb75b37c6a7..bd838fe23da8b 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.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 ae0a81f27bfd1..da4a3b90b273b 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 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 2b07442b80719..e3140ed77d3d5 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 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 eea9f76d5d091..b06b6aa51211e 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 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 2375b75d30af1..40cf1ab115af4 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.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 b133308b61ed5..4336311c82ba2 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 @@ /** * 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 4e3a7b65eb9b8..f062164adab8e 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 @@ 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 19d06cec15f72..a61a866228161 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 @@ * 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 e846a7a90d6b5..6995307503256 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 @@ /** * 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 1cb0f844eb7ca..196b13ed35c41 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 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 aa0f4a645fa02..577f66f94e90f 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 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 e7cd3ae4f2a56..90e09cd7131c7 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 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 baf1fdecfc3ab..32a64fafa7a2d 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 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 47ade91638017..c2983945d5a4c 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.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 aca4cb8c36221..8d036503d1330 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 @@ * 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 98cd9e66d9e7e..d93d80493319a 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 @@ * * * + * + * @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 8b6124cd9cc1f..f9b6a91444873 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.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/CoreValuesSourceType.java b/server/src/main/java/org/opensearch/search/aggregations/support/CoreValuesSourceType.java index 650b554efc1ff..209b996cc5e5e 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 @@ /** * {@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 451afb559c0ac..a6207917d52ea 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 @@ /** * 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 3bb14324058d8..6e0778f9a0a2d 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 @@ /** * 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/MultiValuesSource.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiValuesSource.java index ecc03b046e473..3ef949c6eebbb 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 @@ /** * 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 72d508de1d12e..7573f69e0833e 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 @@ * 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 0ce8e3ea9b5a9..499fa41096de8 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 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 54450763148c8..132b9c15ee4a0 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 @@ -53,6 +53,11 @@ import java.time.ZoneOffset; import java.util.Objects; +/** + * Base field configuration class for multi values + * + * @opensearch.internal + */ public class MultiValuesSourceFieldConfig implements Writeable, ToXContentObject { private final String fieldName; private final Object missing; 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 82054ab53af41..e51465fb93004 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.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 5912a01664e47..e55b78e61d9ba 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.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 a0875737f370e..9bcf7df85d098 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.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 70c36be06a9ae..5eb880642b983 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.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 14d0aa72535fa..69a4a5d8b6703 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 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 623b88c595ce8..e956dd054eba9 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 @@ /** * 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 c1518491b09f9..430accde5c279 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 @@ * 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 6f7a9ec0cc955..86102e63297d1 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 @@ * 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 327437aa2baa2..e53d9b83a814c 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 @@ /** * {@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 ab9a36037c601..22d6fc707bec3 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 @@ /** * {@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 67a55383d101d..a14f6165b9ac2 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 @@ /** * {@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 3cfd673d28c84..520ce124a19da 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 @@ /** * 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 8c162e1fa4a33..88281b12f47eb 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 @@ * {@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 700950cdf894c..a884e5d1be8b5 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 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 e4064eed55f30..be4d73349a39a 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 @@ /** * 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 75f340de4dd16..09a612a15d762 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 @@ /** * Context used for field collapsing + * + * @opensearch.internal */ public class CollapseContext { private final String fieldName;