From 86f8dd65a45810ae671ee1f607a2d5287649d66b Mon Sep 17 00:00:00 2001 From: Nick Knize Date: Wed, 11 May 2022 12:52:28 -0500 Subject: [PATCH] [Javadocs] add to internal classes in o.o.http, indices, and search (#3288) Adds javadocs to internal classes in org.opensearch.http, indices, and search packages. Signed-off-by: Nicholas Walter Knize --- .../src/main/java/org/opensearch/Build.java | 5 ++ .../java/org/opensearch/http/CorsHandler.java | 5 ++ .../java/org/opensearch/http/HttpRequest.java | 5 ++ .../indices/IndexingMemoryController.java | 5 ++ .../opensearch/indices/IndicesQueryCache.java | 10 +++ .../indices/IndicesRequestCache.java | 10 +++ .../opensearch/indices/IndicesService.java | 17 +++++ .../opensearch/indices/NodeIndicesStats.java | 5 ++ .../analysis/PreBuiltCacheFactory.java | 11 +++ .../breaker/AllCircuitBreakerStats.java | 5 ++ .../indices/breaker/CircuitBreakerStats.java | 5 ++ .../HierarchyCircuitBreakerService.java | 10 +++ .../cluster/IndicesClusterStateService.java | 20 ++++++ .../cache/IndicesFieldDataCache.java | 12 ++++ .../indices/recovery/MultiChunkTransfer.java | 10 +++ .../indices/recovery/MultiFileWriter.java | 5 ++ .../recovery/PeerRecoverySourceService.java | 5 ++ .../recovery/PeerRecoveryTargetService.java | 10 +++ .../recovery/RecoveriesCollection.java | 2 + .../recovery/RecoverySourceHandler.java | 20 ++++++ .../indices/recovery/RecoveryState.java | 20 ++++++ .../common/ReplicationLuceneIndex.java | 12 ++++ .../indices/store/IndicesStore.java | 10 +++ .../TransportNodesListShardStoreMetadata.java | 30 ++++++++ .../org/opensearch/search/DocValueFormat.java | 10 +++ .../java/org/opensearch/search/SearchHit.java | 7 ++ .../org/opensearch/search/SearchHits.java | 5 ++ .../org/opensearch/search/SearchService.java | 5 ++ .../aggregations/AggregationBuilder.java | 8 ++- .../search/aggregations/Aggregator.java | 10 ++- .../aggregations/AggregatorFactories.java | 2 + .../aggregations/CardinalityUpperBound.java | 2 + .../aggregations/InternalAggregation.java | 7 ++ .../aggregations/InternalAggregations.java | 5 ++ .../InternalMultiBucketAggregation.java | 5 ++ .../search/aggregations/InternalOrder.java | 10 +++ .../aggregations/MultiBucketCollector.java | 5 ++ .../MultiBucketConsumerService.java | 7 ++ .../ParsedMultiBucketAggregation.java | 5 ++ .../PipelineAggregationBuilder.java | 15 ++++ .../bucket/BestBucketsDeferringCollector.java | 5 ++ .../bucket/BucketsAggregator.java | 20 ++++++ .../bucket/DeferringBucketCollector.java | 5 ++ .../adjacency/AdjacencyMatrixAggregator.java | 5 ++ .../adjacency/InternalAdjacencyMatrix.java | 6 ++ .../adjacency/ParsedAdjacencyMatrix.java | 5 ++ .../composite/CompositeAggregation.java | 5 ++ .../bucket/composite/CompositeAggregator.java | 5 ++ .../CompositeValuesSourceConfig.java | 5 ++ .../DateHistogramValuesSourceBuilder.java | 5 ++ .../GeoTileGridValuesSourceBuilder.java | 5 ++ .../HistogramValuesSourceBuilder.java | 5 ++ .../bucket/composite/InternalComposite.java | 15 ++++ .../bucket/composite/ParsedComposite.java | 5 ++ .../composite/TermsValuesSourceBuilder.java | 6 +- .../bucket/filter/FiltersAggregator.java | 5 ++ .../bucket/filter/InternalFilters.java | 5 ++ .../bucket/filter/ParsedFilters.java | 5 ++ .../bucket/geogrid/CellIdSource.java | 2 + .../geogrid/GeoGridAggregationBuilder.java | 5 ++ .../AutoDateHistogramAggregationBuilder.java | 5 ++ .../AutoDateHistogramAggregator.java | 4 ++ .../bucket/histogram/DateIntervalWrapper.java | 5 ++ .../histogram/InternalAutoDateHistogram.java | 15 ++++ .../histogram/InternalDateHistogram.java | 10 +++ .../bucket/histogram/InternalHistogram.java | 10 +++ .../InternalVariableWidthHistogram.java | 15 ++++ .../histogram/ParsedAutoDateHistogram.java | 5 ++ .../bucket/histogram/ParsedDateHistogram.java | 5 ++ .../bucket/histogram/ParsedHistogram.java | 5 ++ .../ParsedVariableWidthHistogram.java | 5 ++ .../bucket/missing/InternalMissing.java | 5 ++ .../bucket/nested/NestedAggregator.java | 5 ++ .../nested/NestedAggregatorFactory.java | 5 ++ .../ReverseNestedAggregatorFactory.java | 5 ++ .../bucket/range/BinaryRangeAggregator.java | 15 ++++ .../range/GeoDistanceAggregationBuilder.java | 5 ++ .../GeoDistanceRangeAggregatorFactory.java | 5 ++ .../bucket/range/InternalBinaryRange.java | 5 ++ .../bucket/range/InternalDateRange.java | 10 +++ .../bucket/range/InternalGeoDistance.java | 10 +++ .../bucket/range/InternalRange.java | 10 +++ .../range/IpRangeAggregationBuilder.java | 5 ++ .../bucket/range/ParsedBinaryRange.java | 5 ++ .../bucket/range/ParsedDateRange.java | 5 ++ .../bucket/range/ParsedGeoDistance.java | 5 ++ .../bucket/range/ParsedRange.java | 5 ++ .../bucket/range/RangeAggregator.java | 10 +++ .../bucket/sampler/SamplerAggregator.java | 5 ++ .../bucket/terms/BytesKeyedBucketOrds.java | 6 ++ .../bucket/terms/DoubleTerms.java | 5 ++ .../GlobalOrdinalsStringTermsAggregator.java | 9 +++ .../bucket/terms/IncludeExclude.java | 59 ++++++++++++++-- .../bucket/terms/InternalMultiTerms.java | 4 ++ .../bucket/terms/InternalRareTerms.java | 7 ++ .../terms/InternalSignificantTerms.java | 7 ++ .../bucket/terms/InternalTerms.java | 12 ++++ .../bucket/terms/LongKeyedBucketOrds.java | 6 ++ .../bucket/terms/LongRareTerms.java | 5 ++ .../aggregations/bucket/terms/LongTerms.java | 5 ++ .../terms/MapStringTermsAggregator.java | 9 +++ .../terms/MultiTermsAggregationFactory.java | 5 ++ .../bucket/terms/MultiTermsAggregator.java | 4 ++ .../bucket/terms/ParsedDoubleTerms.java | 5 ++ .../bucket/terms/ParsedLongRareTerms.java | 5 ++ .../bucket/terms/ParsedLongTerms.java | 5 ++ .../bucket/terms/ParsedMultiTerms.java | 5 ++ .../bucket/terms/ParsedRareTerms.java | 5 ++ .../terms/ParsedSignificantLongTerms.java | 5 ++ .../terms/ParsedSignificantStringTerms.java | 5 ++ .../bucket/terms/ParsedSignificantTerms.java | 5 ++ .../bucket/terms/ParsedStringRareTerms.java | 5 ++ .../bucket/terms/ParsedStringTerms.java | 5 ++ .../bucket/terms/ParsedTerms.java | 5 ++ .../aggregations/bucket/terms/RareTerms.java | 2 + .../terms/RareTermsAggregatorFactory.java | 5 ++ .../bucket/terms/SignificantLongTerms.java | 5 ++ .../bucket/terms/SignificantStringTerms.java | 5 ++ .../bucket/terms/SignificantTerms.java | 5 ++ .../SignificantTermsAggregatorFactory.java | 5 ++ .../SignificantTextAggregatorFactory.java | 5 ++ .../bucket/terms/StringRareTerms.java | 5 ++ .../bucket/terms/StringTerms.java | 5 ++ .../aggregations/bucket/terms/Terms.java | 2 + .../bucket/terms/TermsAggregator.java | 5 ++ .../bucket/terms/TermsAggregatorFactory.java | 5 ++ .../bucket/terms/UnmappedRareTerms.java | 5 ++ .../terms/UnmappedSignificantTerms.java | 2 + .../bucket/terms/UnmappedTerms.java | 2 + .../bucket/terms/heuristic/ChiSquare.java | 5 ++ .../bucket/terms/heuristic/GND.java | 5 ++ .../bucket/terms/heuristic/JLHScore.java | 5 ++ .../terms/heuristic/MutualInformation.java | 5 ++ .../heuristic/NXYSignificanceHeuristic.java | 10 +++ .../terms/heuristic/PercentageScore.java | 5 ++ .../terms/heuristic/ScriptHeuristic.java | 13 +++- .../metrics/AbstractHyperLogLog.java | 6 +- .../metrics/AbstractLinearCounting.java | 6 +- .../metrics/CardinalityAggregator.java | 37 ++++++++++ .../aggregations/metrics/ExtendedStats.java | 5 ++ .../ExtendedStatsAggregatorProvider.java | 2 + .../metrics/HyperLogLogPlusPlus.java | 20 ++++++ .../metrics/HyperLogLogPlusPlusSparse.java | 10 +++ .../metrics/InternalExtendedStats.java | 10 +++ .../metrics/InternalGeoCentroid.java | 5 ++ .../metrics/InternalHDRPercentileRanks.java | 5 ++ .../metrics/InternalHDRPercentiles.java | 5 ++ .../InternalNumericMetricsAggregation.java | 10 +++ .../aggregations/metrics/InternalStats.java | 10 +++ .../InternalTDigestPercentileRanks.java | 5 ++ .../metrics/InternalTDigestPercentiles.java | 5 ++ .../metrics/NumericMetricsAggregation.java | 10 +++ .../metrics/NumericMetricsAggregator.java | 10 +++ .../metrics/PercentilesConfig.java | 10 +++ .../metrics/TopHitsAggregator.java | 5 ++ .../aggregations/pipeline/BucketHelpers.java | 2 + .../aggregations/pipeline/EwmaModel.java | 5 ++ .../pipeline/HoltLinearModel.java | 5 ++ .../pipeline/HoltWintersModel.java | 10 +++ .../pipeline/InternalPercentilesBucket.java | 5 ++ .../aggregations/pipeline/LinearModel.java | 5 ++ .../aggregations/pipeline/MovAvgModel.java | 2 + .../pipeline/MovingFunctionScript.java | 5 ++ .../pipeline/PipelineAggregator.java | 4 ++ .../aggregations/pipeline/SimpleModel.java | 5 ++ .../aggregations/support/AggregationPath.java | 5 ++ .../support/AggregationUsageService.java | 5 ++ .../BaseMultiValuesSourceFieldConfig.java | 5 ++ .../support/MultiTermsValuesSourceConfig.java | 10 +++ .../support/MultiValuesSource.java | 5 ++ .../MultiValuesSourceAggregationBuilder.java | 5 ++ .../support/MultiValuesSourceFieldConfig.java | 5 ++ .../aggregations/support/ValuesSource.java | 68 +++++++++++++++++++ .../ValuesSourceAggregationBuilder.java | 5 ++ .../support/ValuesSourceRegistry.java | 10 +++ .../search/builder/SearchSourceBuilder.java | 10 +++ .../search/fetch/FetchSubPhase.java | 5 ++ .../fetch/subphase/ScriptFieldsContext.java | 5 ++ .../subphase/highlight/HighlightBuilder.java | 15 ++++ .../subphase/highlight/HighlightUtils.java | 5 ++ .../highlight/SearchHighlightContext.java | 10 +++ .../opensearch/search/query/QueryPhase.java | 4 ++ .../search/rescore/QueryRescorer.java | 5 ++ .../opensearch/search/sort/BucketedSort.java | 24 +++++++ .../search/sort/ScriptSortBuilder.java | 5 ++ .../suggest/SuggestionSearchContext.java | 5 ++ .../completion/CompletionSuggestion.java | 10 +++ .../suggest/completion/FuzzyOptions.java | 2 + .../suggest/completion/RegexOptions.java | 2 + .../context/CategoryContextMapping.java | 2 + .../context/CategoryQueryContext.java | 5 ++ .../completion/context/ContextMapping.java | 10 +++ .../completion/context/GeoContextMapping.java | 5 ++ .../completion/context/GeoQueryContext.java | 5 ++ .../phrase/DirectCandidateGenerator.java | 15 ++++ .../suggest/phrase/PhraseSuggestion.java | 10 +++ .../phrase/PhraseSuggestionBuilder.java | 2 + .../search/suggest/phrase/WordScorer.java | 5 ++ .../search/suggest/term/TermSuggestion.java | 20 ++++-- .../suggest/term/TermSuggestionBuilder.java | 12 +++- 200 files changed, 1521 insertions(+), 18 deletions(-) diff --git a/server/src/main/java/org/opensearch/Build.java b/server/src/main/java/org/opensearch/Build.java index 1d21de6863eef..364b17ad4aa33 100644 --- a/server/src/main/java/org/opensearch/Build.java +++ b/server/src/main/java/org/opensearch/Build.java @@ -56,6 +56,11 @@ public class Build { */ public static final Build CURRENT; + /** + * The type of build + * + * @opensearch.internal + */ public enum Type { DEB("deb"), diff --git a/server/src/main/java/org/opensearch/http/CorsHandler.java b/server/src/main/java/org/opensearch/http/CorsHandler.java index 3a16c8f82e40c..fe6727b76ee28 100644 --- a/server/src/main/java/org/opensearch/http/CorsHandler.java +++ b/server/src/main/java/org/opensearch/http/CorsHandler.java @@ -261,6 +261,11 @@ private void setMaxAge(final HttpResponse response) { response.addHeader(ACCESS_CONTROL_MAX_AGE, Long.toString(config.maxAge)); } + /** + * The cors handler configuration + * + * @opensearch.internal + */ public static class Config { private final boolean enabled; diff --git a/server/src/main/java/org/opensearch/http/HttpRequest.java b/server/src/main/java/org/opensearch/http/HttpRequest.java index 83980c3539ddc..c78db0f40c9f0 100644 --- a/server/src/main/java/org/opensearch/http/HttpRequest.java +++ b/server/src/main/java/org/opensearch/http/HttpRequest.java @@ -49,6 +49,11 @@ */ public interface HttpRequest { + /** + * Which HTTP version being used + * + * @opensearch.internal + */ enum HttpVersion { HTTP_1_0, HTTP_1_1 diff --git a/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java b/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java index ae51a525765ba..611d348fb6791 100644 --- a/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java +++ b/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java @@ -260,6 +260,11 @@ private void recordOperationBytes(Engine.Operation operation, Engine.Result resu } } + /** + * The bytes used by a shard and a reference to the shard + * + * @opensearch.internal + */ private static final class ShardAndBytesUsed implements Comparable { final long bytesUsed; final IndexShard shard; diff --git a/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java b/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java index ce94d769f9c31..78970267f67c2 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java +++ b/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java @@ -216,6 +216,11 @@ public void close() { cache.clear(); } + /** + * Statistics for the indices query cache + * + * @opensearch.internal + */ private static class Stats implements Cloneable { final ShardId shardId; @@ -251,6 +256,11 @@ public String toString() { } } + /** + * Statistics and Counts + * + * @opensearch.internal + */ private static class StatsAndCount { volatile int count; final Stats stats; diff --git a/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java b/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java index 920d3492e0b62..151131e719dc1 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java +++ b/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java @@ -176,6 +176,11 @@ void invalidate(CacheEntity cacheEntity, DirectoryReader reader, BytesReference cache.invalidate(new Key(cacheEntity, reader.getReaderCacheHelper().getKey(), cacheKey)); } + /** + * Loader for the request cache + * + * @opensearch.internal + */ private static class Loader implements CacheLoader { private final CacheEntity entity; @@ -238,6 +243,11 @@ interface CacheEntity extends Accountable { void onRemoval(RemovalNotification notification); } + /** + * Unique key for the cache + * + * @opensearch.internal + */ static class Key implements Accountable { private static final long BASE_RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(Key.class); diff --git a/server/src/main/java/org/opensearch/indices/IndicesService.java b/server/src/main/java/org/opensearch/indices/IndicesService.java index 87cd63119f1d4..b5da0ae1f7688 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesService.java +++ b/server/src/main/java/org/opensearch/indices/IndicesService.java @@ -913,6 +913,11 @@ public IndicesQueryCache getIndicesQueryCache() { return indicesQueryCache; } + /** + * Statistics for old shards + * + * @opensearch.internal + */ static class OldShardsStats implements IndexEventListener { final SearchStats searchStats = new SearchStats(); @@ -1236,6 +1241,11 @@ private void addPendingDelete(Index index, PendingDelete pendingDelete) { } } + /** + * A pending delete + * + * @opensearch.internal + */ private static final class PendingDelete implements Comparable { final Index index; final int shardId; @@ -1386,6 +1396,8 @@ public AnalysisRegistry getAnalysis() { * periodically. In this case it is the field data cache, because a cache that * has an entry invalidated may not clean up the entry if it is not read from * or written to after invalidation. + * + * @opensearch.internal */ private static final class CacheCleaner implements Runnable, Releasable { @@ -1574,6 +1586,11 @@ private BytesReference cacheShardLevelResult( return indicesRequestCache.getOrCompute(cacheEntity, supplier, reader, cacheKey); } + /** + * An item in the index shard cache + * + * @opensearch.internal + */ static final class IndexShardCacheEntity extends AbstractIndexShardCacheEntity { private static final long BASE_RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(IndexShardCacheEntity.class); private final IndexShard indexShard; diff --git a/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java b/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java index b6eedb338b006..5771380023b83 100644 --- a/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java +++ b/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java @@ -271,6 +271,11 @@ public List getShardStats(Index index) { } } + /** + * Fields used for parsing and toXContent + * + * @opensearch.internal + */ static final class Fields { static final String INDICES = "indices"; } diff --git a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltCacheFactory.java b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltCacheFactory.java index 192301c7bd9cf..601bd79a24746 100644 --- a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltCacheFactory.java +++ b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltCacheFactory.java @@ -60,6 +60,11 @@ public enum CachingStrategy { OPENSEARCH } + /** + * The prebuilt cache + * + * @opensearch.internal + */ public interface PreBuiltCache { T get(Version version); @@ -86,6 +91,8 @@ public static PreBuiltCache getCache(CachingStrategy cachingStrategy) { /** * This is a pretty simple cache, it only contains one version + * + * @opensearch.internal */ private static class PreBuiltCacheStrategyOne implements PreBuiltCache { @@ -109,6 +116,8 @@ public Collection values() { /** * This cache contains one version for each opensearch version object + * + * @opensearch.internal */ private static class PreBuiltCacheStrategyOpenSearch implements PreBuiltCache { @@ -132,6 +141,8 @@ public Collection values() { /** * This cache uses the lucene version for caching + * + * @opensearch.internal */ private static class PreBuiltCacheStrategyLucene implements PreBuiltCache { diff --git a/server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java b/server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java index 01284d42a3cf9..0ecb3833fd066 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java +++ b/server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java @@ -87,6 +87,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Fields used for parsing and toXContent + * + * @opensearch.internal + */ static final class Fields { static final String BREAKERS = "breakers"; } diff --git a/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerStats.java b/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerStats.java index 64bf4c16a6059..ab06cfaacd115 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerStats.java +++ b/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerStats.java @@ -132,6 +132,11 @@ public String toString() { + "]"; } + /** + * Fields used for statistics + * + * @opensearch.internal + */ static final class Fields { static final String LIMIT = "limit_size_in_bytes"; static final String LIMIT_HUMAN = "limit_size"; diff --git a/server/src/main/java/org/opensearch/indices/breaker/HierarchyCircuitBreakerService.java b/server/src/main/java/org/opensearch/indices/breaker/HierarchyCircuitBreakerService.java index 02d1e1a76f3f1..c0056aab3fb16 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/HierarchyCircuitBreakerService.java +++ b/server/src/main/java/org/opensearch/indices/breaker/HierarchyCircuitBreakerService.java @@ -341,6 +341,11 @@ public CircuitBreakerStats stats(String name) { ); } + /** + * Tracks memory usage + * + * @opensearch.internal + */ static class MemoryUsage { final long baseUsage; final long totalUsage; @@ -505,6 +510,11 @@ interface OverLimitStrategy { MemoryUsage overLimit(MemoryUsage memoryUsed); } + /** + * Kicks in G1GC if heap gets too high + * + * @opensearch.internal + */ static class G1OverLimitStrategy implements OverLimitStrategy { private final long g1RegionSize; private final LongSupplier currentMemoryUsageSupplier; diff --git a/server/src/main/java/org/opensearch/indices/cluster/IndicesClusterStateService.java b/server/src/main/java/org/opensearch/indices/cluster/IndicesClusterStateService.java index b891784c81d1c..29f74f8a86d85 100644 --- a/server/src/main/java/org/opensearch/indices/cluster/IndicesClusterStateService.java +++ b/server/src/main/java/org/opensearch/indices/cluster/IndicesClusterStateService.java @@ -846,6 +846,11 @@ public void accept(final IndexShard.ShardFailure shardFailure) { } } + /** + * A shard + * + * @opensearch.internal + */ public interface Shard { /** @@ -894,6 +899,11 @@ void updateShardState( ) throws IOException; } + /** + * An allocated index + * + * @opensearch.internal + */ public interface AllocatedIndex extends Iterable, IndexComponent { /** @@ -926,6 +936,11 @@ public interface AllocatedIndex extends Iterable, IndexCompo void removeShard(int shardId, String message); } + /** + * Allocated indices + * + * @opensearch.internal + */ public interface AllocatedIndices> extends Iterable { /** @@ -1012,6 +1027,11 @@ default T getShardOrNull(ShardId shardId) { void processPendingDeletes(Index index, IndexSettings indexSettings, TimeValue timeValue) throws IOException, InterruptedException, ShardLockObtainFailedException; + /** + * Why the index was removed + * + * @opensearch.internal + */ enum IndexRemovalReason { /** * Shard of this index were previously assigned to this node but all shards have been relocated. diff --git a/server/src/main/java/org/opensearch/indices/fielddata/cache/IndicesFieldDataCache.java b/server/src/main/java/org/opensearch/indices/fielddata/cache/IndicesFieldDataCache.java index 01e00fdc19899..1833ae8900a9a 100644 --- a/server/src/main/java/org/opensearch/indices/fielddata/cache/IndicesFieldDataCache.java +++ b/server/src/main/java/org/opensearch/indices/fielddata/cache/IndicesFieldDataCache.java @@ -125,6 +125,11 @@ public void onRemoval(RemovalNotification notification) { } } + /** + * Computes a weight based on ramBytesUsed + * + * @opensearch.internal + */ public static class FieldDataWeigher implements ToLongBiFunction { @Override public long applyAsLong(Key key, Accountable ramUsage) { @@ -135,6 +140,8 @@ public long applyAsLong(Key key, Accountable ramUsage) { /** * A specific cache instance for the relevant parameters of it (index, fieldNames, fieldType). + * + * @opensearch.internal */ static class IndexFieldCache implements IndexFieldDataCache, IndexReader.ClosedListener { private final Logger logger; @@ -242,6 +249,11 @@ public void clear(String fieldName) { } } + /** + * Key for the indices field data cache + * + * @opensearch.internal + */ public static class Key { public final IndexFieldCache indexCache; public final IndexReader.CacheKey readerKey; diff --git a/server/src/main/java/org/opensearch/indices/recovery/MultiChunkTransfer.java b/server/src/main/java/org/opensearch/indices/recovery/MultiChunkTransfer.java index 8a6aa0db26610..4cc75de7cd5d9 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/MultiChunkTransfer.java +++ b/server/src/main/java/org/opensearch/indices/recovery/MultiChunkTransfer.java @@ -211,6 +211,11 @@ protected void onNewResource(Source resource) throws IOException { protected abstract void handleError(Source resource, Exception e) throws Exception; + /** + * A file chunk item as the response + * + * @opensearch.internal + */ private static class FileChunkResponseItem { final long requestSeqId; final Source source; @@ -223,6 +228,11 @@ private static class FileChunkResponseItem { } } + /** + * A chunk request + * + * @opensearch.internal + */ public interface ChunkRequest { /** * @return {@code true} if this chunk request is the last chunk of the current file diff --git a/server/src/main/java/org/opensearch/indices/recovery/MultiFileWriter.java b/server/src/main/java/org/opensearch/indices/recovery/MultiFileWriter.java index 8ea9a85597837..3509615052707 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/MultiFileWriter.java +++ b/server/src/main/java/org/opensearch/indices/recovery/MultiFileWriter.java @@ -199,6 +199,11 @@ public void renameAllTempFiles() throws IOException { store.renameTempFilesSafe(tempFileNames); } + /** + * A file chunk + * + * @opensearch.internal + */ static final class FileChunk { final StoreFileMetadata md; final BytesReference content; diff --git a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoverySourceService.java b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoverySourceService.java index 1eb0fe2c1929d..a1cf78920cf7e 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoverySourceService.java +++ b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoverySourceService.java @@ -79,6 +79,11 @@ public class PeerRecoverySourceService extends AbstractLifecycleComponent implem private static final Logger logger = LogManager.getLogger(PeerRecoverySourceService.class); + /** + * The internal actions + * + * @opensearch.internal + */ public static class Actions { public static final String START_RECOVERY = "internal:index/shard/recovery/start_recovery"; public static final String REESTABLISH_RECOVERY = "internal:index/shard/recovery/reestablish_recovery"; diff --git a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryTargetService.java b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryTargetService.java index a85925ff5cff4..4ae188abe5896 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryTargetService.java +++ b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryTargetService.java @@ -102,6 +102,11 @@ public class PeerRecoveryTargetService implements IndexEventListener { private static final Logger logger = LogManager.getLogger(PeerRecoveryTargetService.class); + /** + * The internal actions + * + * @opensearch.internal + */ public static class Actions { public static final String FILES_INFO = "internal:index/shard/recovery/filesInfo"; public static final String FILE_CHUNK = "internal:index/shard/recovery/file_chunk"; @@ -340,6 +345,11 @@ public static StartRecoveryRequest getStartRecoveryRequest( return request; } + /** + * The recovery listener + * + * @opensearch.internal + */ public interface RecoveryListener { void onRecoveryDone(RecoveryState state); diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveriesCollection.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveriesCollection.java index 0312dfeec4eeb..38b72dd0f7dee 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveriesCollection.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveriesCollection.java @@ -274,6 +274,8 @@ public boolean cancelRecoveriesForShard(ShardId shardId, String reason) { * a reference to {@link RecoveryTarget}, which implements {@link AutoCloseable}. closing the reference * causes {@link RecoveryTarget#decRef()} to be called. This makes sure that the underlying resources * will not be freed until {@link RecoveryRef#close()} is called. + * + * @opensearch.internal */ public static class RecoveryRef extends AutoCloseableRefCounted { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoverySourceHandler.java b/server/src/main/java/org/opensearch/indices/recovery/RecoverySourceHandler.java index fdbdbf4c688e2..0870fd4ca9295 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoverySourceHandler.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoverySourceHandler.java @@ -498,6 +498,11 @@ private void runWithGenericThreadPool(CheckedRunnable task) { FutureUtils.get(future); } + /** + * A send file result + * + * @opensearch.internal + */ static final class SendFileResult { final List phase1FileNames; final List phase1FileSizes; @@ -853,6 +858,11 @@ void phase2( sender.start(); } + /** + * An operation chunk request + * + * @opensearch.internal + */ private static class OperationChunkRequest implements MultiChunkTransfer.ChunkRequest { final List operations; final boolean lastChunk; @@ -1009,6 +1019,11 @@ void finalizeRecovery(long targetLocalCheckpoint, long trimAboveSeqNo, ActionLis }, listener::onFailure); } + /** + * A result for a send snapshot + * + * @opensearch.internal + */ static final class SendSnapshotResult { final long targetLocalCheckpoint; final int sentOperations; @@ -1041,6 +1056,11 @@ public String toString() { + '}'; } + /** + * A file chunk from the recovery source + * + * @opensearch.internal + */ private static class FileChunk implements MultiChunkTransfer.ChunkRequest, Releasable { final StoreFileMetadata md; final BytesReference content; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryState.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryState.java index edca0aaa2124a..35ac5cbc12bde 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryState.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryState.java @@ -58,6 +58,11 @@ */ public class RecoveryState implements ToXContentFragment, Writeable { + /** + * The stage of the recovery state + * + * @opensearch.internal + */ public enum Stage { INIT((byte) 0), @@ -328,6 +333,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Fields used in the recovery state + * + * @opensearch.internal + */ static final class Fields { static final String ID = "id"; static final String TYPE = "type"; @@ -356,6 +366,11 @@ static final class Fields { static final String PERCENT = "percent"; } + /** + * Verifys the lucene index + * + * @opensearch.internal + */ public static class VerifyIndex extends ReplicationTimer implements ToXContentFragment, Writeable { private volatile long checkIndexTime; @@ -393,6 +408,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws } } + /** + * The translog + * + * @opensearch.internal + */ public static class Translog extends ReplicationTimer implements ToXContentFragment, Writeable { public static final int UNKNOWN = -1; diff --git a/server/src/main/java/org/opensearch/indices/replication/common/ReplicationLuceneIndex.java b/server/src/main/java/org/opensearch/indices/replication/common/ReplicationLuceneIndex.java index ee8919d0dc9c4..d1066b867f982 100644 --- a/server/src/main/java/org/opensearch/indices/replication/common/ReplicationLuceneIndex.java +++ b/server/src/main/java/org/opensearch/indices/replication/common/ReplicationLuceneIndex.java @@ -307,6 +307,11 @@ public synchronized FileMetadata getFileDetails(String dest) { return filesDetails.get(dest); } + /** + * Details about the files + * + * @opensearch.internal + */ private static final class FilesDetails implements ToXContentFragment, Writeable { protected final Map fileMetadataMap = new HashMap<>(); protected boolean complete; @@ -397,6 +402,11 @@ public boolean isComplete() { } } + /** + * Metadata about a file + * + * @opensearch.internal + */ public static final class FileMetadata implements ToXContentObject, Writeable { private String name; private long length; @@ -500,6 +510,8 @@ public String toString() { /** * Duplicates many of Field names in {@link RecoveryState} + * + * @opensearch.internal */ static final class Fields { static final String TOTAL_TIME = "total_time"; diff --git a/server/src/main/java/org/opensearch/indices/store/IndicesStore.java b/server/src/main/java/org/opensearch/indices/store/IndicesStore.java index 11442632246b6..96e84fb69b573 100644 --- a/server/src/main/java/org/opensearch/indices/store/IndicesStore.java +++ b/server/src/main/java/org/opensearch/indices/store/IndicesStore.java @@ -452,6 +452,11 @@ private IndexShard getShard(ShardActiveRequest request) { } + /** + * A shard active request + * + * @opensearch.internal + */ private static class ShardActiveRequest extends TransportRequest { protected TimeValue timeout = null; private ClusterName clusterName; @@ -483,6 +488,11 @@ public void writeTo(StreamOutput out) throws IOException { } } + /** + * The shard active response + * + * @opensearch.internal + */ private static class ShardActiveResponse extends TransportResponse { private final boolean shardActive; diff --git a/server/src/main/java/org/opensearch/indices/store/TransportNodesListShardStoreMetadata.java b/server/src/main/java/org/opensearch/indices/store/TransportNodesListShardStoreMetadata.java index 538a8c871cb5f..b49cdcd127962 100644 --- a/server/src/main/java/org/opensearch/indices/store/TransportNodesListShardStoreMetadata.java +++ b/server/src/main/java/org/opensearch/indices/store/TransportNodesListShardStoreMetadata.java @@ -77,6 +77,11 @@ import java.util.Objects; import java.util.concurrent.TimeUnit; +/** + * Metadata for shard stores from a list of transport nodes + * + * @opensearch.internal + */ public class TransportNodesListShardStoreMetadata extends TransportNodesAction< TransportNodesListShardStoreMetadata.Request, TransportNodesListShardStoreMetadata.NodesStoreFilesMetadata, @@ -225,6 +230,11 @@ private StoreFilesMetadata listStoreMetadata(NodeRequest request) throws IOExcep } } + /** + * Metadata for store files + * + * @opensearch.internal + */ public static class StoreFilesMetadata implements Iterable, Writeable { private final ShardId shardId; private final Store.MetadataSnapshot metadataSnapshot; @@ -318,6 +328,11 @@ public String toString() { } } + /** + * The request + * + * @opensearch.internal + */ public static class Request extends BaseNodesRequest { private final ShardId shardId; @@ -364,6 +379,11 @@ public void writeTo(StreamOutput out) throws IOException { } } + /** + * Metadata for the nodes store files + * + * @opensearch.internal + */ public static class NodesStoreFilesMetadata extends BaseNodesResponse { public NodesStoreFilesMetadata(StreamInput in) throws IOException { @@ -385,6 +405,11 @@ protected void writeNodesTo(StreamOutput out, List nodes } } + /** + * The node request + * + * @opensearch.internal + */ public static class NodeRequest extends BaseNodeRequest { private final ShardId shardId; @@ -431,6 +456,11 @@ public String getCustomDataPath() { } } + /** + * The metadata for the node store files + * + * @opensearch.internal + */ public static class NodeStoreFilesMetadata extends BaseNodeResponse { private StoreFilesMetadata storeFilesMetadata; diff --git a/server/src/main/java/org/opensearch/search/DocValueFormat.java b/server/src/main/java/org/opensearch/search/DocValueFormat.java index 5c8bcfb4dcf7c..7e7e4f83334f5 100644 --- a/server/src/main/java/org/opensearch/search/DocValueFormat.java +++ b/server/src/main/java/org/opensearch/search/DocValueFormat.java @@ -201,6 +201,11 @@ static DocValueFormat withNanosecondResolution(final DocValueFormat format) { } } + /** + * Date time doc value format + * + * @opensearch.internal + */ final class DateTime implements DocValueFormat { public static final String NAME = "date_time"; @@ -406,6 +411,11 @@ public String toString() { } }; + /** + * Decimal doc value format + * + * @opensearch.internal + */ final class Decimal implements DocValueFormat { public static final String NAME = "decimal"; diff --git a/server/src/main/java/org/opensearch/search/SearchHit.java b/server/src/main/java/org/opensearch/search/SearchHit.java index 8297ae0798e7d..89eeddb07ce5d 100644 --- a/server/src/main/java/org/opensearch/search/SearchHit.java +++ b/server/src/main/java/org/opensearch/search/SearchHit.java @@ -590,6 +590,11 @@ public void setInnerHits(Map innerHits) { this.innerHits = innerHits; } + /** + * Fields in a search hit used for parsing and toXContent + * + * @opensearch.internal + */ public static class Fields { static final String _INDEX = "_index"; static final String _ID = "_id"; @@ -1000,6 +1005,8 @@ public int hashCode() { /** * Encapsulates the nested identity of a hit. + * + * @opensearch.internal */ public static final class NestedIdentity implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/search/SearchHits.java b/server/src/main/java/org/opensearch/search/SearchHits.java index 67198608e7d9e..c4bb0ca3a1137 100644 --- a/server/src/main/java/org/opensearch/search/SearchHits.java +++ b/server/src/main/java/org/opensearch/search/SearchHits.java @@ -201,6 +201,11 @@ public Iterator iterator() { return Arrays.stream(getHits()).iterator(); } + /** + * Fields for parsing and toXContent + * + * @opensearch.internal + */ public static final class Fields { public static final String HITS = "hits"; public static final String TOTAL = "total"; diff --git a/server/src/main/java/org/opensearch/search/SearchService.java b/server/src/main/java/org/opensearch/search/SearchService.java index 9b2e1e3168344..3b24d52bebe53 100644 --- a/server/src/main/java/org/opensearch/search/SearchService.java +++ b/server/src/main/java/org/opensearch/search/SearchService.java @@ -1418,6 +1418,11 @@ private static PipelineTree requestToPipelineTree(SearchRequest request) { return request.source().aggregations().buildPipelineTree(); } + /** + * Search phase result that can match a response + * + * @opensearch.internal + */ public static final class CanMatchResponse extends SearchPhaseResult { private final boolean canMatch; private final MinAndMax estimatedMinAndMax; 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 5c76f0cc091c3..f5f11834b4484 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregationBuilder.java @@ -166,6 +166,8 @@ public PipelineTree buildPipelineTree() { *

* Unlike {@link CardinalityUpperBound} which is total * instead of per parent bucket. + * + * @opensearch.internal */ public enum BucketCardinality { NONE, @@ -179,7 +181,11 @@ public enum BucketCardinality { */ public abstract BucketCardinality bucketCardinality(); - /** Common xcontent fields shared among aggregator builders */ + /** + * Common xcontent fields shared among aggregator builders + * + * @opensearch.internal + */ public static final class CommonFields extends ParseField.CommonFields { public static final ParseField VALUE_TYPE = new ParseField("value_type"); } 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 99a54bbdc27b0..c1aa0965b0328 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/Aggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/Aggregator.java @@ -63,6 +63,8 @@ public abstract class Aggregator extends BucketCollector implements Releasable { * Parses the aggregation request and creates the appropriate aggregator factory for it. * * @see AggregationBuilder + * + * @opensearch.internal */ @FunctionalInterface public interface Parser { @@ -157,6 +159,8 @@ public BucketComparator bucketComparator(String key, SortOrder order) { /** * Compare two buckets by their ordinal. + * + * @opensearch.internal */ @FunctionalInterface public interface BucketComparator { @@ -204,7 +208,11 @@ public final InternalAggregation buildTopLevel() throws IOException { */ public void collectDebugInfo(BiConsumer add) {} - /** Aggregation mode for sub aggregations. */ + /** + * Aggregation mode for sub aggregations. + * + * @opensearch.internal + */ public enum SubAggCollectionMode implements Writeable { /** 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 ec536578f7251..75e887fbe0d0a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactories.java +++ b/server/src/main/java/org/opensearch/search/aggregations/AggregatorFactories.java @@ -295,6 +295,8 @@ public int countAggregators() { /** * A mutable collection of {@link AggregationBuilder}s and * {@link PipelineAggregationBuilder}s. + * + * @opensearch.internal */ public static class Builder implements Writeable, ToXContentObject { private final Set names = new HashSet<>(); 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 7596cf471c4a3..15beeac82930a 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/CardinalityUpperBound.java +++ b/server/src/main/java/org/opensearch/search/aggregations/CardinalityUpperBound.java @@ -113,6 +113,8 @@ private CardinalityUpperBound() { /** * Cardinality estimate with a known upper bound. + * + * @opensearch.internal */ private static class KnownCardinalityUpperBound extends CardinalityUpperBound { private final int estimate; 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 55c400218b06b..6ccd429388873 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalAggregation.java @@ -64,6 +64,8 @@ public abstract class InternalAggregation implements Aggregation, NamedWriteable { /** * Builds {@link ReduceContext}. + * + * @opensearch.internal */ public interface ReduceContextBuilder { /** @@ -77,6 +79,11 @@ public interface ReduceContextBuilder { ReduceContext forFinalReduction(); } + /** + * The reduce context + * + * @opensearch.internal + */ public static class ReduceContext { private final BigArrays bigArrays; private final ScriptService scriptService; 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 fb8fb18598dac..79dd8d756dede 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalAggregations.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalAggregations.java @@ -304,6 +304,11 @@ public long getSerializedSize() { } } + /** + * A counting stream output + * + * @opensearch.internal + */ private static class CountingStreamOutput extends StreamOutput { long size = 0; 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 b519334e6f92e..c191507cf991f 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalMultiBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalMultiBucketAggregation.java @@ -223,6 +223,11 @@ private List reducePipelineBuckets(ReduceContext reduceContext, PipelineTree return reducedBuckets; } + /** + * An internal buck for the internal multibucket agg + * + * @opensearch.internal + */ public abstract static class InternalBucket implements Bucket, Writeable { public Object getProperty(String containingAggName, List path) { 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 491e08bc847d1..ba1c6eea049c9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/InternalOrder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/InternalOrder.java @@ -65,6 +65,8 @@ public abstract class InternalOrder extends BucketOrder { // TODO merge the contents of this file into BucketOrder. The way it is now is relic. /** * {@link Bucket} ordering strategy to sort by a sub-aggregation. + * + * @opensearch.internal */ public static class Aggregation extends InternalOrder { static final byte ID = 0; @@ -133,6 +135,8 @@ public boolean equals(Object obj) { /** * {@link Bucket} ordering strategy to sort by multiple criteria. + * + * @opensearch.internal */ public static class CompoundOrder extends BucketOrder { @@ -244,6 +248,8 @@ public boolean equals(Object obj) { * {@link BucketOrder} implementation for simple, fixed orders like * {@link InternalOrder#COUNT_ASC}. Complex implementations should not * use this. + * + * @opensearch.internal */ private static class SimpleOrder extends InternalOrder { private final byte id; @@ -405,6 +411,8 @@ private static boolean isOrder(BucketOrder order, BucketOrder expected) { /** * Contains logic for reading/writing {@link BucketOrder} from/to streams. + * + * @opensearch.internal */ public static class Streams { @@ -493,6 +501,8 @@ public static void writeHistogramOrder(BucketOrder order, StreamOutput out, bool /** * Contains logic for parsing a {@link BucketOrder} from a {@link XContentParser}. + * + * @opensearch.internal */ public static class Parser { 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 80c7b37624fa5..8f7222729efdb 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/MultiBucketCollector.java +++ b/server/src/main/java/org/opensearch/search/aggregations/MultiBucketCollector.java @@ -176,6 +176,11 @@ public LeafBucketCollector getLeafCollector(LeafReaderContext context) throws IO } } + /** + * A multi leaf bucket collector + * + * @opensearch.internal + */ private static class MultiLeafBucketCollector extends LeafBucketCollector { private final boolean cacheScores; 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 d7c1796b1715f..ec1729a0f5180 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/MultiBucketConsumerService.java +++ b/server/src/main/java/org/opensearch/search/aggregations/MultiBucketConsumerService.java @@ -76,6 +76,11 @@ private void setMaxBucket(int maxBucket) { this.maxBucket = maxBucket; } + /** + * Thrown when there are too many buckets + * + * @opensearch.internal + */ public static class TooManyBucketsException extends AggregationExecutionException { private final int maxBuckets; @@ -115,6 +120,8 @@ protected void metadataToXContent(XContentBuilder builder, Params params) throws * when the sum of the provided values is above the limit (`search.max_buckets`). * It is used by aggregators to limit the number of bucket creation during * {@link Aggregator#buildAggregations} and {@link InternalAggregation#reduce}. + * + * @opensearch.internal */ public static class MultiBucketConsumer implements IntConsumer { private final int limit; 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 6258295a2b733..d3997598baf08 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/ParsedMultiBucketAggregation.java +++ b/server/src/main/java/org/opensearch/search/aggregations/ParsedMultiBucketAggregation.java @@ -99,6 +99,11 @@ protected static void declareMultiBucketAggregationFields( }, CommonFields.BUCKETS, ObjectParser.ValueType.OBJECT_ARRAY); } + /** + * A parsed bucket + * + * @opensearch.internal + */ public abstract static class ParsedBucket implements MultiBucketsAggregation.Bucket { private Aggregations aggregations; 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 6aba50ec912d8..dea7455c2e975 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregationBuilder.java +++ b/server/src/main/java/org/opensearch/search/aggregations/PipelineAggregationBuilder.java @@ -97,6 +97,11 @@ public final String[] getBucketsPaths() { */ protected abstract void validate(ValidationContext context); + /** + * The context used for validation + * + * @opensearch.internal + */ public abstract static class ValidationContext { /** * Build the context for the root of the aggregation tree. @@ -122,6 +127,11 @@ private ValidationContext(ActionRequestValidationException validationFailuresSoF this.e = validationFailuresSoFar; } + /** + * The root of the tree + * + * @opensearch.internal + */ private static class ForTreeRoot extends ValidationContext { private final Collection siblingAggregations; private final Collection siblingPipelineAggregations; @@ -162,6 +172,11 @@ public void validateParentAggSequentiallyOrdered(String type, String name) { } } + /** + * The internal tree node + * + * @opensearch.internal + */ private static class ForInsideTree extends ValidationContext { private final AggregationBuilder parent; 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 f3addc9522a94..2e7c4659bcb00 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 @@ -65,6 +65,11 @@ * @opensearch.internal */ public class BestBucketsDeferringCollector extends DeferringBucketCollector { + /** + * Entry in the bucket collector + * + * @opensearch.internal + */ static class Entry { final LeafReaderContext context; final PackedLongValues docDeltas; 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 9e35a2745fc90..79512586d06de 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 @@ -330,6 +330,11 @@ protected final InternalAggregation[] buildAggregationsForFixedBucketCount( return results; } + /** + * A bucket builder for a fixed count + * + * @opensearch.internal + */ @FunctionalInterface protected interface BucketBuilderForFixedCount { B build(int offsetInOwningOrd, int docCount, InternalAggregations subAggregationResults); @@ -355,6 +360,11 @@ protected final InternalAggregation[] buildAggregationsForSingleBucket(long[] ow return results; } + /** + * A single bucket result builder + * + * @opensearch.internal + */ @FunctionalInterface protected interface SingleBucketResultBuilder { InternalAggregation build(long owningBucketOrd, InternalAggregations subAggregationResults); @@ -415,11 +425,21 @@ protected final InternalAggregation[] buildAggregationsForVariableBuckets( return results; } + /** + * A bucket builder for a variable + * + * @opensearch.internal + */ @FunctionalInterface protected interface BucketBuilderForVariable { B build(long bucketValue, int docCount, InternalAggregations subAggregationResults); } + /** + * A result builder for a bucket variable + * + * @opensearch.internal + */ @FunctionalInterface protected interface ResultBuilderForVariable { InternalAggregation build(long owninigBucketOrd, List buckets); 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 d11fcfd104af1..cfac1046c77b4 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 @@ -72,6 +72,11 @@ public Aggregator wrap(final Aggregator in) { return new WrappedAggregator(in); } + /** + * A wrapped aggregator + * + * @opensearch.internal + */ protected class WrappedAggregator extends Aggregator { private Aggregator in; 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 1cae870a378a5..c33887878dbd6 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 @@ -72,6 +72,11 @@ public class AdjacencyMatrixAggregator extends BucketsAggregator { public static final ParseField FILTERS_FIELD = new ParseField("filters"); + /** + * A keyed filter + * + * @opensearch.internal + */ protected static class KeyedFilter implements Writeable, ToXContentFragment { private final String key; private final QueryBuilder filter; 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 52a8d638d8e1d..d3920b3e5151d 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 @@ -56,6 +56,12 @@ public class InternalAdjacencyMatrix extends InternalMultiBucketAggregation implements AdjacencyMatrix { + + /** + * An internal bucket of the adjacency matrix + * + * @opensearch.internal + */ public static class InternalBucket extends InternalMultiBucketAggregation.InternalBucket implements AdjacencyMatrix.Bucket { private final String key; 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 f211c072cbd1f..0a9ae67e29f65 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 @@ -90,6 +90,11 @@ public static ParsedAdjacencyMatrix fromXContent(XContentParser parser, String n return aggregation; } + /** + * A parsed bucket + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements AdjacencyMatrix.Bucket { private String key; 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 06ec7f8b1baf7..48374499d0e5c 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 @@ -45,6 +45,11 @@ * @opensearch.internal */ public interface CompositeAggregation extends MultiBucketsAggregation { + /** + * Bucket in a composite agg + * + * @opensearch.internal + */ interface Bucket extends MultiBucketsAggregation.Bucket { Map getKey(); } 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 94fc48708c41f..a907d17a731fe 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 @@ -577,6 +577,11 @@ public void collect(int doc, long zeroBucket) throws IOException { }; } + /** + * An entry in the composite aggregator + * + * @opensearch.internal + */ private static class Entry { final LeafReaderContext context; final DocIdSet docIdSet; 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 c85099976b297..f26fc2144c9b6 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 @@ -50,6 +50,11 @@ */ public class CompositeValuesSourceConfig { + /** + * A single dimension provider + * + * @opensearch.internal + */ @FunctionalInterface public interface SingleDimensionValuesSourceProvider { SingleDimensionValuesSource createValuesSource( 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 ece8f506cbc4d..1d3a96e66885b 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 @@ -75,6 +75,11 @@ public class DateHistogramValuesSourceBuilder extends CompositeValuesSourceBuilder implements DateIntervalConsumer { + /** + * Supplier for a composite date histogram + * + * @opensearch.internal + */ @FunctionalInterface public interface DateHistogramCompositeSupplier { CompositeValuesSourceConfig apply( 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 d4252d132ee12..4b01a08d29a43 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 @@ -68,6 +68,11 @@ * @opensearch.internal */ public class GeoTileGridValuesSourceBuilder extends CompositeValuesSourceBuilder { + /** + * Supplier for a composite geotile + * + * @opensearch.internal + */ @FunctionalInterface public interface GeoTileCompositeSuppier { CompositeValuesSourceConfig apply( 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 f087d2d0495dc..7f1393f7c8fb2 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 @@ -61,6 +61,11 @@ * @opensearch.internal */ public class HistogramValuesSourceBuilder extends CompositeValuesSourceBuilder { + /** + * Composite histogram supplier + * + * @opensearch.internal + */ @FunctionalInterface public interface HistogramCompositeSupplier { CompositeValuesSourceConfig apply( 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 8b28c1a7c5ae4..49e3d3293527a 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 @@ -317,6 +317,11 @@ public int hashCode() { return Objects.hash(super.hashCode(), size, buckets, afterKey, Arrays.hashCode(reverseMuls), Arrays.hashCode(missingOrders)); } + /** + * The bucket iterator + * + * @opensearch.internal + */ private static class BucketIterator implements Comparable { final Iterator it; InternalBucket current; @@ -335,6 +340,11 @@ InternalBucket next() { } } + /** + * Internal bucket for the internal composite agg + * + * @opensearch.internal + */ public static class InternalBucket extends InternalMultiBucketAggregation.InternalBucket implements CompositeAggregation.Bucket, @@ -516,6 +526,11 @@ static Object formatObject(Object obj, DocValueFormat format) { return obj; } + /** + * An array map used for the internal composite agg + * + * @opensearch.internal + */ static class ArrayMap extends AbstractMap implements Comparable { final List keys; final Comparable[] values; 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 965dc42a1e011..69ac30bd6df73 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 @@ -106,6 +106,11 @@ protected XContentBuilder doXContentBody(XContentBuilder builder, Params params) return CompositeAggregation.toXContentFragment(this, builder, params); } + /** + * Parsed bucket for the parsed composite agg + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements CompositeAggregation.Bucket { private Map key; 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 ea1fc88e5cc32..64b2635ea7fee 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 @@ -62,7 +62,11 @@ * @opensearch.internal */ public class TermsValuesSourceBuilder extends CompositeValuesSourceBuilder { - + /** + * Composite supplier for terms + * + * @opensearch.internal + */ @FunctionalInterface public interface TermsCompositeSupplier { CompositeValuesSourceConfig apply( 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 1b58d5372c5bf..efdecbdd84deb 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 @@ -71,6 +71,11 @@ public class FiltersAggregator extends BucketsAggregator { public static final ParseField OTHER_BUCKET_FIELD = new ParseField("other_bucket"); public static final ParseField OTHER_BUCKET_KEY_FIELD = new ParseField("other_bucket_key"); + /** + * Keyed filter for the filters agg + * + * @opensearch.internal + */ public static class KeyedFilter implements Writeable, ToXContentFragment { private final String key; private final QueryBuilder filter; 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 ba7cb41f63abb..c15caa46d52f4 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 @@ -53,6 +53,11 @@ * @opensearch.internal */ public class InternalFilters extends InternalMultiBucketAggregation implements Filters { + /** + * Internal bucket for an internal filters agg + * + * @opensearch.internal + */ public static class InternalBucket extends InternalMultiBucketAggregation.InternalBucket implements Filters.Bucket { private final boolean keyed; 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 0ac821b6c8a11..22a9165b4181f 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 @@ -106,6 +106,11 @@ public static ParsedFilters fromXContent(XContentParser parser, String name) thr return aggregation; } + /** + * Parsed bucket for the parsed filters agg + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Filters.Bucket { private String key; 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 bf47fe218073b..12d9043a2fd5f 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 @@ -89,6 +89,8 @@ public SortedBinaryDocValues bytesValues(LeafReaderContext ctx) { /** * The encoder to use to convert a geopoint's (lon, lat, precision) into * a long-encoded bucket key for aggregating. + * + * @opensearch.internal */ @FunctionalInterface public interface GeoPointLongEncoder { 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 c235626e09a10..b08c40268c5cf 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 @@ -73,6 +73,11 @@ public abstract class GeoGridAggregationBuilder extends ValuesSourceAggregationB protected int shardSize; private GeoBoundingBox geoBoundingBox = new GeoBoundingBox(new GeoPoint(Double.NaN, Double.NaN), new GeoPoint(Double.NaN, Double.NaN)); + /** + * A precision parser + * + * @opensearch.internal + */ @FunctionalInterface protected interface PrecisionParser { int parse(XContentParser parser) throws IOException; 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 9321617174400..6b6d33717bab4 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 @@ -286,6 +286,11 @@ public boolean equals(Object obj) { return Objects.equals(numBuckets, other.numBuckets) && Objects.equals(minimumIntervalExpression, other.minimumIntervalExpression); } + /** + * Round off information + * + * @opensearch.internal + */ public static class RoundingInfo implements Writeable { final Rounding rounding; final int[] innerIntervals; 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 587e838568046..ec3c8ed5207a4 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 @@ -243,6 +243,8 @@ protected final void merge(long[] mergeMap, long newNumBuckets) { * rebucket roughly {@code O(log number_of_hits_collected_so_far)} because * the "shape" of the roundings is roughly * logarithmically increasing. + * + * @opensearch.internal */ private static class FromSingle extends AutoDateHistogramAggregator { private int roundingIdx; @@ -406,6 +408,8 @@ protected void doClose() { * rounding all of the keys for {@code owningBucketOrd} that we're going to * collect and picking the rounding based on a real, accurate count and the * min and max. + * + * @opensearch.internal */ private static class FromMany extends AutoDateHistogramAggregator { /** 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 6c187f7924a19..d378bb2ec1bd2 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 @@ -75,6 +75,11 @@ public class DateIntervalWrapper implements ToXContentFragment, Writeable { private static final ParseField FIXED_INTERVAL_FIELD = new ParseField("fixed_interval"); private static final ParseField CALENDAR_INTERVAL_FIELD = new ParseField("calendar_interval"); + /** + * The type of interval + * + * @opensearch.internal + */ public enum IntervalTypeEnum implements Writeable { NONE, FIXED, 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 55ef48211bcb4..a91ddf2e64879 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 @@ -66,6 +66,11 @@ public final class InternalAutoDateHistogram extends InternalMultiBucketAggregat InternalAutoDateHistogram, InternalAutoDateHistogram.Bucket> implements Histogram, HistogramFactory { + /** + * Bucket for the internal auto date histogram agg + * + * @opensearch.internal + */ public static class Bucket extends InternalMultiBucketAggregation.InternalBucket implements Histogram.Bucket, KeyComparable { final long key; @@ -157,6 +162,11 @@ public DocValueFormat getFormatter() { } } + /** + * Information about the bucket + * + * @opensearch.internal + */ static class BucketInfo { final RoundingInfo[] roundingInfos; @@ -422,6 +432,11 @@ protected Bucket reduceBucket(List buckets, ReduceContext context) { return new InternalAutoDateHistogram.Bucket(buckets.get(0).key, docCount, format, aggs); } + /** + * The result from a bucket reduce + * + * @opensearch.internal + */ private static class BucketReduceResult { final List buckets; final int roundingIdx; 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 068d6533c59b3..9aa6fd180c77b 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 @@ -68,6 +68,11 @@ public final class InternalDateHistogram extends InternalMultiBucketAggregation< Histogram, HistogramFactory { + /** + * Bucket for an internal date histogram agg + * + * @opensearch.internal + */ public static class Bucket extends InternalMultiBucketAggregation.InternalBucket implements Histogram.Bucket, KeyComparable { final long key; @@ -170,6 +175,11 @@ public boolean getKeyed() { } } + /** + * Information about an empty bucket + * + * @opensearch.internal + */ static class EmptyBucketInfo { final Rounding rounding; 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 c11f483392c25..23e9fb7a8b456 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 @@ -64,6 +64,11 @@ public final class InternalHistogram extends InternalMultiBucketAggregation { final double key; @@ -166,6 +171,11 @@ public boolean getKeyed() { } } + /** + * Information about an empty bucket + * + * @opensearch.internal + */ public static class EmptyBucketInfo { final double interval, offset, minBound, maxBound; 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 ec4be47e4a62f..f6b5e23acbc91 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 @@ -62,8 +62,18 @@ public class InternalVariableWidthHistogram extends InternalMultiBucketAggregati InternalVariableWidthHistogram, InternalVariableWidthHistogram.Bucket> implements Histogram, HistogramFactory { + /** + * Bucket for an internal variable width histogram + * + * @opensearch.internal + */ public static class Bucket extends InternalMultiBucketAggregation.InternalBucket implements Histogram.Bucket, KeyComparable { + /** + * Bounds of the bucket + * + * @opensearch.internal + */ public static class BucketBounds { public double min; public double max; @@ -219,6 +229,11 @@ public DocValueFormat getFormatter() { } } + /** + * Information about an empty bucket + * + * @opensearch.internal + */ static class EmptyBucketInfo { final InternalAggregations subAggregations; 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 83f776d34a17e..95cf93b7229db 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 @@ -97,6 +97,11 @@ protected XContentBuilder doXContentBody(XContentBuilder builder, Params params) return builder; } + /** + * A parsed bucket for a parsed auto date histogram agg + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Histogram.Bucket { private Long key; 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 248f41f213031..b961aba135683 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 @@ -78,6 +78,11 @@ public static ParsedDateHistogram fromXContent(XContentParser parser, String nam return aggregation; } + /** + * Parsed Bucket for a parsed date histogram + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Histogram.Bucket { private Long key; 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 1cc7865d22f45..ff63079da29a4 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 @@ -75,6 +75,11 @@ public static ParsedHistogram fromXContent(XContentParser parser, String name) t return aggregation; } + /** + * Parsed bucket for a parsed histogram + * + * @opensearch.internal + */ static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Histogram.Bucket { private Double key; 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 c03221af74c15..4ac3ef6ea57cd 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 @@ -84,6 +84,11 @@ public static ParsedVariableWidthHistogram fromXContent(XContentParser parser, S return aggregation; } + /** + * Parsed bucket for a parsed variable width histogram + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Histogram.Bucket { private Double key; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/InternalMissing.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/InternalMissing.java index a9aeda3f941cf..7cc86483f0b56 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/InternalMissing.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/missing/InternalMissing.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.util.Map; +/** + * Missing single bucket agg + * + * @opensearch.internal + */ public class InternalMissing extends InternalSingleBucketAggregation implements Missing { InternalMissing(String name, long docCount, InternalAggregations aggregations, Map metadata) { super(name, docCount, aggregations, metadata); 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 dc536aebc0cde..5dc4d1c780350 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 @@ -230,6 +230,11 @@ void processBufferedChildBuckets() throws IOException { } } + /** + * A cached scorable doc + * + * @opensearch.internal + */ private static class CachedScorable extends Scorable { int doc; float score; 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 22b87280c8534..ca1018795b518 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 @@ -82,6 +82,11 @@ public Aggregator createInternal( return new NestedAggregator(name, factories, parentObjectMapper, childObjectMapper, searchContext, parent, cardinality, metadata); } + /** + * Unmapped class for nested agg + * + * @opensearch.internal + */ private static final class Unmapped extends NonCollectingAggregator { Unmapped(String name, SearchContext context, Aggregator parent, AggregatorFactories factories, Map metadata) 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 2929df697ea58..27cd8a2688836 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 @@ -83,6 +83,11 @@ public Aggregator createInternal( } } + /** + * Unmapped class for reverse nested agg + * + * @opensearch.internal + */ private static final class Unmapped extends NonCollectingAggregator { Unmapped(String name, SearchContext context, Aggregator parent, AggregatorFactories factories, Map metadata) 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 c846ba6c48b20..a48649af99be3 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 @@ -62,6 +62,11 @@ */ public final class BinaryRangeAggregator extends BucketsAggregator { + /** + * Range for the binary range agg + * + * @opensearch.internal + */ public static class Range { final String key; @@ -144,6 +149,11 @@ protected void doCollect(LeafBucketCollector sub, int doc, long bucket) throws I } } + /** + * Leaf collector for the sorted set range + * + * @opensearch.internal + */ abstract static class SortedSetRangeLeafCollector extends LeafBucketCollectorBase { final long[] froms, tos, maxTos; @@ -250,6 +260,11 @@ private int collect(int doc, long ord, long bucket, int lowBound) throws IOExcep protected abstract void doCollect(LeafBucketCollector sub, int doc, long bucket) throws IOException; } + /** + * Base class for a sorted binary range leaf collector + * + * @opensearch.internal + */ abstract static class SortedBinaryRangeLeafCollector extends LeafBucketCollectorBase { final Range[] ranges; 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 701f46719b8e3..944a580efdeb7 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 @@ -121,6 +121,11 @@ public static AggregationBuilder parse(String aggregationName, XContentParser pa return builder; } + /** + * Range for a geo distance agg + * + * @opensearch.internal + */ public static class Range extends RangeAggregator.Range { public Range(String key, Double from, Double to) { super(key(key, from, to), from == null ? 0 : from, to); 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 cd8179f00a842..64c618e93510f 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 @@ -172,6 +172,11 @@ protected Aggregator doCreateInternal( ); } + /** + * The source location for the distance calculation + * + * @opensearch.internal + */ private static class DistanceSource extends ValuesSource.Numeric { private final ValuesSource.GeoPoint source; 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 95e04d3f47e7e..fad1705278f04 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 @@ -61,6 +61,11 @@ public final class InternalBinaryRange extends InternalMultiBucketAggregation { public static final Factory FACTORY = new Factory(); + /** + * Bucket for a date range + * + * @opensearch.internal + */ public static class Bucket extends InternalRange.Bucket { public Bucket( @@ -113,6 +118,11 @@ DocValueFormat format() { } } + /** + * Factory to create a date range + * + * @opensearch.internal + */ public static class Factory extends InternalRange.Factory { @Override public ValueType getValueType() { 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 0cbe572e31917..4d5e9cbfb7e49 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 @@ -50,6 +50,11 @@ public class InternalGeoDistance extends InternalRange { public static final Factory FACTORY = new Factory(); + /** + * Bucket for a geo distance range + * + * @opensearch.internal + */ static class Bucket extends InternalRange.Bucket { Bucket(String key, double from, double to, long docCount, InternalAggregations aggregations, boolean keyed) { @@ -66,6 +71,11 @@ boolean keyed() { } } + /** + * Factory for a geo distance bucket + * + * @opensearch.internal + */ public static class Factory extends InternalRange.Factory { @Override public ValuesSourceType getValueSourceType() { 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 8da0d132fd54f..274b3741e6acb 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 @@ -59,6 +59,11 @@ public class InternalRange> { public ValuesSourceType getValueSourceType() { return CoreValuesSourceType.NUMERIC; 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 843733d736bc0..cc304f987bc61 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 @@ -128,6 +128,11 @@ private static Range parseRange(XContentParser parser) throws IOException { } } + /** + * Range for an IP range + * + * @opensearch.internal + */ public static class Range implements ToXContentObject { private final String key; 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 68f8aae9aefb9..58c235f6df9a4 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 @@ -82,6 +82,11 @@ public static ParsedBinaryRange fromXContent(XContentParser parser, String name) return aggregation; } + /** + * Parsed bucket for a binary range + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Range.Bucket { private String key; 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 889b57b1a128c..3cff1b6a5fea5 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 @@ -71,6 +71,11 @@ public static ParsedDateRange fromXContent(XContentParser parser, String name) t return aggregation; } + /** + * Parsed bucket for a date range + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedRange.ParsedBucket { @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 86fa2555c727c..8902adea1e799 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 @@ -68,6 +68,11 @@ public static ParsedGeoDistance fromXContent(XContentParser parser, String name) return aggregation; } + /** + * Parsed bucket for a geo distance + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedRange.ParsedBucket { static ParsedBucket fromXContent(final XContentParser parser, final boolean keyed) throws IOException { 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 0ad192636c0a7..1eda34de1c1e0 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 @@ -92,6 +92,11 @@ public static ParsedRange fromXContent(XContentParser parser, String name) throw return aggregation; } + /** + * Parsed bucket for a range + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Range.Bucket { protected String key; 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 4d2b0437adb08..40a455597a016 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 @@ -75,6 +75,11 @@ public class RangeAggregator extends BucketsAggregator { public static final ParseField RANGES_FIELD = new ParseField("ranges"); public static final ParseField KEYED_FIELD = new ParseField("keyed"); + /** + * Range for the range aggregator + * + * @opensearch.internal + */ public static class Range implements Writeable, ToXContentObject { public static final ParseField KEY_FIELD = new ParseField("key"); public static final ParseField FROM_FIELD = new ParseField("from"); @@ -383,6 +388,11 @@ public InternalAggregation buildEmptyAggregation() { return rangeFactory.create(name, buckets, format, keyed, metadata()); } + /** + * Unmapped range + * + * @opensearch.internal + */ public static class Unmapped extends NonCollectingAggregator { private final R[] ranges; 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 fd1d7bf2997ac..afbf52cbdd04e 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 @@ -73,6 +73,11 @@ public class SamplerAggregator extends DeferableBucketAggregator implements Sing static final long SCOREDOCKEY_SIZE = RamUsageEstimator.shallowSizeOfInstance(DiversifiedTopDocsCollector.ScoreDocKey.class); + /** + * The execution mode for the sampler + * + * @opensearch.internal + */ public enum ExecutionMode { MAP(new ParseField("map")) { 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 7bfeff7615b83..0eb23013d1e47 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 @@ -82,6 +82,8 @@ private BytesKeyedBucketOrds() {} /** * An iterator for buckets inside a particular {@code owningBucketOrd}. + * + * @opensearch.internal */ public interface BucketOrdsEnum { /** @@ -122,6 +124,8 @@ public void readValue(BytesRef dest) {} /** * Implementation that only works if it is collecting from a single bucket. + * + * @opensearch.internal */ private static class FromSingle extends BytesKeyedBucketOrds { private final BytesRefHash ords; @@ -177,6 +181,8 @@ public void close() { /** * Implementation that works properly when collecting from many buckets. + * + * @opensearch.internal */ private static class FromMany extends BytesKeyedBucketOrds { // TODO we can almost certainly do better here by building something fit for purpose rather than trying to lego together stuff 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 7f2765657781a..6b44b2cdb8cb7 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 @@ -53,6 +53,11 @@ public class DoubleTerms extends InternalMappedTerms { public static final String NAME = "dterms"; + /** + * Bucket for a double terms agg + * + * @opensearch.internal + */ static class Bucket extends InternalTerms.Bucket { double term; 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 4be90ac2f9b7a..4fcc42b6211b2 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 @@ -90,6 +90,11 @@ public class GlobalOrdinalsStringTermsAggregator extends AbstractStringTermsAggr protected int segmentsWithSingleValuedOrds = 0; protected int segmentsWithMultiValuedOrds = 0; + /** + * Lookup global ordinals + * + * @opensearch.internal + */ public interface GlobalOrdLookupFunction { BytesRef apply(long ord) throws IOException; } @@ -231,6 +236,8 @@ public void collectDebugInfo(BiConsumer add) { /** * This is used internally only, just for compare using global ordinal instead of term bytes in the PQ + * + * @opensearch.internal */ static class OrdBucket extends InternalTerms.Bucket { long globalOrd; @@ -284,6 +291,8 @@ protected void doClose() { * This is only supported for the standard {@code terms} aggregation and * doesn't support {@code significant_terms} so this forces * {@link StandardTermsResults}. + * + * @opensearch.internal */ static class LowCardinality extends GlobalOrdinalsStringTermsAggregator { 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 4464e4eb54760..ea4ee87f28a95 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 @@ -162,16 +162,29 @@ public static IncludeExclude parseExclude(XContentParser parser) throws IOExcept } } + /** + * Base filter class + * + * @opensearch.internal + */ public abstract static class Filter {} - // The includeValue and excludeValue ByteRefs which are the result of the parsing - // process are converted into a LongFilter when used on numeric fields - // in the index. + /** + * The includeValue and excludeValue ByteRefs which are the result of the parsing + * process are converted into a LongFilter when used on numeric fields + * in the index. + * + * @opensearch.internal + */ public abstract static class LongFilter extends Filter { public abstract boolean accept(long value); - } + /** + * Long filter that is partitioned + * + * @opensearch.internal + */ public class PartitionedLongFilter extends LongFilter { @Override public boolean accept(long value) { @@ -181,6 +194,11 @@ public boolean accept(long value) { } } + /** + * Long filter backed by valid values + * + * @opensearch.internal + */ public static class SetBackedLongFilter extends LongFilter { private LongSet valids; private LongSet invalids; @@ -208,7 +226,11 @@ private void addReject(long val) { } } - // Only used for the 'map' execution mode (ie. scripts) + /** + * Only used for the 'map' execution mode (ie. scripts) + * + * @opensearch.internal + */ public abstract static class StringFilter extends Filter { public abstract boolean accept(BytesRef value); } @@ -220,6 +242,11 @@ public boolean accept(BytesRef value) { } } + /** + * String filter backed by an automaton + * + * @opensearch.internal + */ static class AutomatonBackedStringFilter extends StringFilter { private final ByteRunAutomaton runAutomaton; @@ -237,6 +264,11 @@ public boolean accept(BytesRef value) { } } + /** + * String filter backed by a term list + * + * @opensearch.internal + */ static class TermListBackedStringFilter extends StringFilter { private final Set valids; @@ -257,6 +289,11 @@ public boolean accept(BytesRef value) { } } + /** + * An ordinals filter + * + * @opensearch.internal + */ public abstract static class OrdinalsFilter extends Filter { public abstract LongBitSet acceptedGlobalOrdinals(SortedSetDocValues globalOrdinals) throws IOException; @@ -284,6 +321,11 @@ public LongBitSet acceptedGlobalOrdinals(SortedSetDocValues globalOrdinals) thro } } + /** + * An ordinals filter backed by an automaton + * + * @opensearch.internal + */ static class AutomatonBackedOrdinalsFilter extends OrdinalsFilter { private final CompiledAutomaton compiled; @@ -311,6 +353,11 @@ public LongBitSet acceptedGlobalOrdinals(SortedSetDocValues globalOrdinals) thro } + /** + * An ordinals filter backed by a terms list + * + * @opensearch.internal + */ static class TermListBackedOrdinalsFilter extends OrdinalsFilter { private final SortedSet includeValues; @@ -508,6 +555,8 @@ private static SortedSet convertToBytesRefSet(long[] values) { /** * Terms adapter around doc values. + * + * @opensearch.internal */ private static class DocValuesTerms extends Terms { diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java index f9207fb17a431..c0422dffd7cad 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/InternalMultiTerms.java @@ -36,6 +36,8 @@ public class InternalMultiTerms extends InternalTerms { /** * Internal Multi Terms Bucket. + * + * @opensearch.internal */ public static class Bucket extends InternalTerms.AbstractInternalBucket implements KeyComparable { @@ -193,6 +195,8 @@ public int compareKey(Bucket other) { /** * Visible for testing. + * + * @opensearch.internal */ protected static class BucketComparator implements Comparator> { @SuppressWarnings({ "unchecked" }) 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 441a0783536d5..f6dbf17d54644 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 @@ -60,12 +60,19 @@ public abstract class InternalRareTerms, B ext implements RareTerms { + /** + * Bucket for a rare terms agg + * + * @opensearch.internal + */ public abstract static class Bucket> extends InternalMultiBucketAggregation.InternalBucket implements RareTerms.Bucket, KeyComparable { /** * Reads a bucket. Should be a constructor reference. + * + * @opensearch.internal */ @FunctionalInterface public interface Reader> { 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 80fd4e2f5dc7a..3e7a6210350aa 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 @@ -62,12 +62,19 @@ public abstract class InternalSignificantTerms> extends InternalMultiBucketAggregation.InternalBucket implements SignificantTerms.Bucket { /** * Reads a bucket. Should be a constructor reference. + * + * @opensearch.internal */ @FunctionalInterface public interface Reader> { 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 a376d7fab900b..68f25032a02a4 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 @@ -75,6 +75,11 @@ public abstract class InternalTerms, B extends Int protected static final ParseField DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME = new ParseField("doc_count_error_upper_bound"); protected static final ParseField SUM_OF_OTHER_DOC_COUNTS = new ParseField("sum_other_doc_count"); + /** + * Base internal multi bucket + * + * @opensearch.internal + */ public abstract static class AbstractInternalBucket extends InternalMultiBucketAggregation.InternalBucket implements Terms.Bucket { abstract void setDocCountError(long docCountError); @@ -83,9 +88,16 @@ public abstract static class AbstractInternalBucket extends InternalMultiBucketA abstract boolean showDocCountError(); } + /** + * Base bucket class + * + * @opensearch.internal + */ public abstract static class Bucket> extends AbstractInternalBucket implements KeyComparable { /** * Reads a bucket. Should be a constructor reference. + * + * @opensearch.internal */ @FunctionalInterface public interface Reader> { 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 d60c774adaa3c..bcf77ee194ea4 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 @@ -100,6 +100,8 @@ private LongKeyedBucketOrds() {} /** * An iterator for buckets inside a particular {@code owningBucketOrd}. + * + * @opensearch.internal */ public interface BucketOrdsEnum { /** @@ -142,6 +144,8 @@ public long value() { /** * Implementation that only works if it is collecting from a single bucket. + * + * @opensearch.internal */ public static class FromSingle extends LongKeyedBucketOrds { private final LongHash ords; @@ -221,6 +225,8 @@ public void close() { /** * Implementation that works properly when collecting from many buckets. + * + * @opensearch.internal */ public static class FromMany extends LongKeyedBucketOrds { private final LongLongHash ords; 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 f65401f913a89..4a18d0ea7482a 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 @@ -52,6 +52,11 @@ public class LongRareTerms extends InternalMappedRareTerms { public static final String NAME = "lrareterms"; + /** + * Bucket for rare long valued terms + * + * @opensearch.internal + */ public static class Bucket extends InternalRareTerms.Bucket { long term; 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 2a92749943256..d9e7ad18751f3 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 @@ -53,6 +53,11 @@ public class LongTerms extends InternalMappedTerms { public static final String NAME = "lterms"; + /** + * Bucket for long terms + * + * @opensearch.internal + */ public static class Bucket extends InternalTerms.Bucket { long term; 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 2450a5a3692e1..8ef33667e972c 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 @@ -153,6 +153,8 @@ public void doClose() { /** * Abstaction on top of building collectors to fetch values. + * + * @opensearch.internal */ public interface CollectorSource extends Releasable { boolean needsScores(); @@ -166,6 +168,11 @@ LeafBucketCollector getLeafCollector( ) throws IOException; } + /** + * Consumer for the collector + * + * @opensearch.internal + */ @FunctionalInterface public interface CollectConsumer { void accept(LeafBucketCollector sub, int doc, long owningBucketOrd, BytesRef bytes) throws IOException; @@ -173,6 +180,8 @@ public interface CollectConsumer { /** * Fetch values from a {@link ValuesSource}. + * + * @opensearch.internal */ public static class ValuesSourceCollectorSource implements CollectorSource { private final ValuesSource valuesSource; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java index 695972564f720..8a061c0fbf512 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregationFactory.java @@ -159,6 +159,11 @@ protected Aggregator createInternal( ); } + /** + * Supplier for internal values source + * + * @opensearch.internal + */ public interface InternalValuesSourceSupplier { MultiTermsAggregator.InternalValuesSource build(Tuple config); } diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java index e5461ff7a03aa..45898a689a605 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/MultiTermsAggregator.java @@ -304,6 +304,8 @@ interface InternalValuesSourceCollector { /** * Multi_Term ValuesSource, it is a collection of {@link InternalValuesSource} + * + * @opensearch.internal */ static class MultiTermsValuesSource { private final List valuesSources; @@ -354,6 +356,8 @@ private void apply( /** * Factory for construct {@link InternalValuesSource}. + * + * @opensearch.internal */ static class InternalValuesSourceFactory { static InternalValuesSource bytesValuesSource(ValuesSource valuesSource, IncludeExclude.StringFilter includeExclude) { 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 2ace6b637e6df..d41e8ccf73246 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 @@ -65,6 +65,11 @@ public static ParsedDoubleTerms fromXContent(XContentParser parser, String name) return aggregation; } + /** + * Parsed bucket for double terms + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedTerms.ParsedBucket { private Double key; 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 c66f3cd676893..634ed164dc5ab 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 @@ -65,6 +65,11 @@ public static ParsedLongRareTerms fromXContent(XContentParser parser, String nam return aggregation; } + /** + * Parsed bucket for rare long values + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedRareTerms.ParsedBucket { private Long key; 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 45f51854aa603..1d2b17e7d9130 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 @@ -65,6 +65,11 @@ public static ParsedLongTerms fromXContent(XContentParser parser, String name) t return aggregation; } + /** + * Parsed bucket for long term values + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedTerms.ParsedBucket { private Long key; diff --git a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java index 3e1c6f6533b06..52199c6dbbfb9 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java +++ b/server/src/main/java/org/opensearch/search/aggregations/bucket/terms/ParsedMultiTerms.java @@ -41,6 +41,11 @@ public static ParsedMultiTerms fromXContent(XContentParser parser, String name) return aggregation; } + /** + * Parsed bucket for multi terms + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedTerms.ParsedBucket { private List key; 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 f195028244913..0af5347d290b6 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 @@ -85,6 +85,11 @@ static void declareParsedTermsFields( declareMultiBucketAggregationFields(objectParser, bucketParser::apply, bucketParser::apply); } + /** + * Parsed Bucket for rare term values + * + * @opensearch.internal + */ public abstract static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements RareTerms.Bucket { @Override 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 23c29b2745f73..49bf854f05f72 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 @@ -63,6 +63,11 @@ public static ParsedSignificantLongTerms fromXContent(XContentParser parser, Str return parseSignificantTermsXContent(() -> PARSER.parse(parser, null), name); } + /** + * Parsed bucket for significant long values + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedSignificantTerms.ParsedBucket { private Long key; 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 ce508687aed6c..7953a476e2899 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 @@ -65,6 +65,11 @@ public static ParsedSignificantStringTerms fromXContent(XContentParser parser, S return parseSignificantTermsXContent(() -> PARSER.parse(parser, null), name); } + /** + * Parsed bucket for significant string values + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedSignificantTerms.ParsedBucket { private BytesRef key; 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 1d6b64f3dcd0b..654086c28168d 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 @@ -128,6 +128,11 @@ static void declareParsedSignificantTermsFields( ); } + /** + * Parsed bucket for significant values + * + * @opensearch.internal + */ public abstract static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements SignificantTerms.Bucket { protected long subsetDf; 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 ecf5bd84097b0..ee1b8f7e235e0 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 @@ -67,6 +67,11 @@ public static ParsedStringRareTerms fromXContent(XContentParser parser, String n return aggregation; } + /** + * Parsed bucket for rare string terms + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedRareTerms.ParsedBucket { private BytesRef key; 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 c849d6c8c8840..e5dfb7f9d07e9 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 @@ -67,6 +67,11 @@ public static ParsedStringTerms fromXContent(XContentParser parser, String name) return aggregation; } + /** + * Parsed bucket for string values + * + * @opensearch.internal + */ public static class ParsedBucket extends ParsedTerms.ParsedBucket { private BytesRef key; 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 68de52a253188..841eddccc239a 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 @@ -109,6 +109,11 @@ static void declareParsedTermsFields( objectParser.declareLong((parsedTerms, value) -> parsedTerms.sumOtherDocCount = value, SUM_OF_OTHER_DOC_COUNTS); } + /** + * Base parsed bucket + * + * @opensearch.internal + */ public abstract static class ParsedBucket extends ParsedMultiBucketAggregation.ParsedBucket implements Terms.Bucket { boolean showDocCountError = false; 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 6e26503c149c5..f930e199e8f1b 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 @@ -44,6 +44,8 @@ public interface RareTerms extends MultiBucketsAggregation { /** * A bucket that is associated with a single term + * + * @opensearch.internal */ interface Bucket extends MultiBucketsAggregation.Bucket { 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 b689865ac8c99..f15d0bd9bc644 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 @@ -237,6 +237,11 @@ protected Aggregator doCreateInternal( ); } + /** + * Execution mode for rare terms agg + * + * @opensearch.internal + */ public enum ExecutionMode { MAP(new ParseField("map")) { 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 6e2b48f55796e..9106824d9df7c 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 @@ -51,6 +51,11 @@ public class SignificantLongTerms extends InternalMappedSignificantTerms { public static final String NAME = "siglterms"; + /** + * Bucket for significant long values + * + * @opensearch.internal + */ static class Bucket extends InternalSignificantTerms.Bucket { long term; 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 3795df964b0c4..9e9c7100c0842 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 @@ -52,6 +52,11 @@ public class SignificantStringTerms extends InternalMappedSignificantTerms { public static final String NAME = "sigsterms"; + /** + * Bucket for significant string values + * + * @opensearch.internal + */ public static class Bucket extends InternalSignificantTerms.Bucket { BytesRef termBytes; 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 a5d1c29b0ee0a..e2eeac18575b0 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 @@ -42,6 +42,11 @@ */ public interface SignificantTerms extends MultiBucketsAggregation, Iterable { + /** + * Bucket for significant terms + * + * @opensearch.internal + */ interface Bucket extends MultiBucketsAggregation.Bucket { /** 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 ff35d128ef524..12b11dae33613 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 @@ -311,6 +311,11 @@ protected Aggregator doCreateInternal( ); } + /** + * The execution mode for the significant terms agg + * + * @opensearch.internal + */ public enum ExecutionMode { MAP(new ParseField("map")) { 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 a509cbfd49ffd..39711cf0901f5 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 @@ -173,6 +173,11 @@ protected Aggregator createInternal( ); } + /** + * Collects significant text + * + * @opensearch.internal + */ private static class SignificantTextCollectorSource implements MapStringTermsAggregator.CollectorSource { private final SourceLookup sourceLookup; private final BigArrays bigArrays; 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 f6a925c5340a1..9b1047587969b 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 @@ -53,6 +53,11 @@ public class StringRareTerms extends InternalMappedRareTerms { public static final String NAME = "srareterms"; + /** + * Bucket for rare string terms + * + * @opensearch.internal + */ public static class Bucket extends InternalRareTerms.Bucket { BytesRef termBytes; 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 829ec07c91087..c053c80a101dc 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 @@ -52,6 +52,11 @@ public class StringTerms extends InternalMappedTerms { public static final String NAME = "sterms"; + /** + * Bucket for string terms + * + * @opensearch.internal + */ public static class Bucket extends InternalTerms.Bucket { BytesRef termBytes; 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 df2028c81b1eb..e2e07ffa6ae59 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 @@ -45,6 +45,8 @@ public interface Terms extends MultiBucketsAggregation { /** * A bucket that is associated with a single term + * + * @opensearch.internal */ interface Bucket extends MultiBucketsAggregation.Bucket { 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 d60d1609ae9d4..c63b410f2e468 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 @@ -63,6 +63,11 @@ */ public abstract class TermsAggregator extends DeferableBucketAggregator { + /** + * Bucket count thresholds + * + * @opensearch.internal + */ public static class BucketCountThresholds implements Writeable, ToXContentFragment { private long minDocCount; private long shardMinDocCount; 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 abbd7945bdde4..50b1ae001db97 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 @@ -365,6 +365,11 @@ private static long getMaxOrd(ValuesSource source, IndexSearcher searcher) throw } } + /** + * The execution mode for the terms agg + * + * @opensearch.internal + */ public enum ExecutionMode { MAP(new ParseField("map")) { 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 279bbf95641e0..1be7c82c26dc8 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 @@ -54,6 +54,11 @@ public class UnmappedRareTerms extends InternalRareTerms { public static final String NAME = "umrareterms"; + /** + * Bucket for unmapped rare values + * + * @opensearch.internal + */ protected abstract static class Bucket extends InternalRareTerms.Bucket { private Bucket(long docCount, InternalAggregations aggregations, DocValueFormat formatter) { super(docCount, aggregations, formatter); 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 535a6b58059a5..35914e9ebed43 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 @@ -60,6 +60,8 @@ public class UnmappedSignificantTerms extends InternalSignificantTerms { private Bucket( 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 9b792720b492a..164a3b1b7cf19 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 @@ -57,6 +57,8 @@ public class UnmappedTerms extends InternalTerms { private Bucket( 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 1597976986beb..fd19fc8cfbaea 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 @@ -108,6 +108,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Builder for a chi squared heuristic + * + * @opensearch.internal + */ public static class ChiSquareBuilder extends NXYSignificanceHeuristic.NXYBuilder { public ChiSquareBuilder(boolean includeNegatives, boolean backgroundIsSuperset) { super(includeNegatives, backgroundIsSuperset); 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 4f315836d9b3c..23f3815f779ae 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 @@ -127,6 +127,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Builder for a GND heuristic + * + * @opensearch.internal + */ public static class GNDBuilder extends NXYBuilder { public GNDBuilder(boolean backgroundIsSuperset) { super(true, backgroundIsSuperset); 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 1b36947f72d02..4032334eba68f 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 @@ -129,6 +129,11 @@ public int hashCode() { return getClass().hashCode(); } + /** + * Builder for a JLH Score heuristic + * + * @opensearch.internal + */ public static class JLHScoreBuilder implements SignificanceHeuristicBuilder { @Override 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 761e1cf31da10..e9198f0f4d3df 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 @@ -147,6 +147,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Builder for a Mutual Information heuristic + * + * @opensearch.internal + */ public static class MutualInformationBuilder extends NXYBuilder { public MutualInformationBuilder(boolean includeNegatives, boolean backgroundIsSuperset) { super(includeNegatives, backgroundIsSuperset); 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 e385bea5a7c11..cdb1349765317 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 @@ -106,6 +106,11 @@ public int hashCode() { return result; } + /** + * Frequencies for an NXY significance heuristic + * + * @opensearch.internal + */ protected static class Frequencies { double N00, N01, N10, N11, N0_, N1_, N_0, N_1, N; } @@ -194,6 +199,11 @@ protected static Function buildFromParsedArgs(BiFunction add) { add.accept("string_hashing_collectors_used", stringHashingCollectorsUsed); } + /** + * Collector for the cardinality agg + * + * @opensearch.internal + */ private abstract static class Collector extends LeafBucketCollector implements Releasable { public abstract void postCollect() throws IOException; } + /** + * Empty Collector for the Cardinality agg + * + * @opensearch.internal + */ private static class EmptyCollector extends Collector { @Override @@ -225,6 +235,11 @@ public void close() { } } + /** + * Direct Collector for the cardinality agg + * + * @opensearch.internal + */ private static class DirectCollector extends Collector { private final MurmurHash3Values hashes; @@ -257,6 +272,11 @@ public void close() { } + /** + * Ordinals Collector for the cardinality agg + * + * @opensearch.internal + */ private static class OrdinalsCollector extends Collector { private static final long SHALLOW_FIXEDBITSET_SIZE = RamUsageEstimator.shallowSizeOfInstance(FixedBitSet.class); @@ -345,6 +365,8 @@ public void close() { /** * Representation of a list of hash values. There might be dups and there is no guarantee on the order. + * + * @opensearch.internal */ abstract static class MurmurHash3Values { @@ -375,6 +397,11 @@ public static MurmurHash3Values hash(SortedBinaryDocValues values) { return new Bytes(values); } + /** + * Long hash value + * + * @opensearch.internal + */ private static class Long extends MurmurHash3Values { private final SortedNumericDocValues values; @@ -399,6 +426,11 @@ public long nextValue() throws IOException { } } + /** + * Double hash value + * + * @opensearch.internal + */ private static class Double extends MurmurHash3Values { private final SortedNumericDoubleValues values; @@ -423,6 +455,11 @@ public long nextValue() throws IOException { } } + /** + * Byte hash value + * + * @opensearch.internal + */ private static class Bytes extends MurmurHash3Values { private final MurmurHash3.Hash128 hash = new MurmurHash3.Hash128(); 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 36e9c1f93866c..811a7e08caed3 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 @@ -118,6 +118,11 @@ public interface ExtendedStats extends Stats { */ String getVarianceSamplingAsString(); + /** + * The bounds of the extended stats + * + * @opensearch.internal + */ enum Bounds { UPPER, LOWER, 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 88cdf60b7aebe..3c19c0b5867a1 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 @@ -40,6 +40,8 @@ /** * Base supplier of an ExtendesStats aggregator + * + * @opensearch.internal */ public interface ExtendedStatsAggregatorProvider { 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 bfc121627bfe7..1e33b78d3f6c5 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 @@ -225,6 +225,11 @@ private void merge(long thisBucket, AbstractHyperLogLog.RunLenIterator runLens) } } + /** + * The hyper log log + * + * @opensearch.internal + */ private static class HyperLogLog extends AbstractHyperLogLog implements Releasable { private final BigArrays bigArrays; private final HyperLogLogIterator iterator; @@ -269,6 +274,11 @@ public void close() { } } + /** + * Iterator for hyper log log + * + * @opensearch.internal + */ private static class HyperLogLogIterator implements AbstractHyperLogLog.RunLenIterator { private final HyperLogLog hll; @@ -304,6 +314,11 @@ public byte value() { } } + /** + * The plus plus + * + * @opensearch.internal + */ private static class LinearCounting extends AbstractLinearCounting implements Releasable { protected final int threshold; @@ -397,6 +412,11 @@ public void close() { } } + /** + * The plus plus iterator + * + * @opensearch.internal + */ private static class LinearCountingIterator implements AbstractLinearCounting.HashesIterator { private final LinearCounting lc; 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 9a042726423e7..252df7358ddcd 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 @@ -98,6 +98,11 @@ protected void addEncoded(long bucket, int encoded) { lc.addEncoded(bucket, encoded); } + /** + * The plus plus + * + * @opensearch.internal + */ private static class LinearCounting extends AbstractLinearCounting implements Releasable { private final int capacity; @@ -189,6 +194,11 @@ public void close() { } } + /** + * The plus plus iterator + * + * @opensearch.internal + */ private static class LinearCountingIterator implements AbstractLinearCounting.HashesIterator { private final LinearCounting lc; 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 75a4dbb4e74dd..cfc6e06b2cbdf 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 @@ -48,6 +48,11 @@ * @opensearch.internal */ public class InternalExtendedStats extends InternalStats implements ExtendedStats { + /** + * The metrics for the extended stats + * + * @opensearch.internal + */ enum Metrics { count, @@ -304,6 +309,11 @@ public InternalExtendedStats reduce(List aggregations, Redu ); } + /** + * Fields for internal extended stats + * + * @opensearch.internal + */ static class Fields { public static final String SUM_OF_SQRS = "sum_of_squares"; public static final String SUM_OF_SQRS_AS_STRING = "sum_of_squares_as_string"; 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 262f8cc890192..96e7541de25d9 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 @@ -177,6 +177,11 @@ public Object getProperty(List path) { } } + /** + * Fields for geo centroid + * + * @opensearch.internal + */ static class Fields { static final ParseField CENTROID = new ParseField("location"); static final ParseField COUNT = new ParseField("count"); 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 ba3c917d1b5e6..f517fb678e44f 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 @@ -114,6 +114,11 @@ public static double percentileRank(DoubleHistogram state, double value) { return percentileRank; } + /** + * Terator for HDR percentile ranks agg + * + * @opensearch.internal + */ public static class Iter implements Iterator { private final double[] values; 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 2b1da6387494b..6bfab8c26ac9a 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 @@ -104,6 +104,11 @@ protected AbstractInternalHDRPercentiles createReduced( return new InternalHDRPercentiles(name, keys, merged, keyed, format, metadata); } + /** + * Iterator for HDR percentiles + * + * @opensearch.internal + */ public static class Iter implements Iterator { private final double[] percents; 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 2c66321ecb331..2ef86786d4b13 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 @@ -53,6 +53,11 @@ public abstract class InternalNumericMetricsAggregation extends InternalAggregat protected DocValueFormat format = DEFAULT_FORMAT; + /** + * A single numeric metric value + * + * @opensearch.internal + */ public abstract static class SingleValue extends InternalNumericMetricsAggregation implements NumericMetricsAggregation.SingleValue { protected SingleValue(String name, Map metadata) { super(name, metadata); @@ -96,6 +101,11 @@ public final double sortValue(String key) { } } + /** + * Multe numeric metric values + * + * @opensearch.internal + */ public abstract static class MultiValue extends InternalNumericMetricsAggregation implements NumericMetricsAggregation.MultiValue { protected MultiValue(String name, Map metadata) { super(name, metadata); 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 6bd48f221346b..f9407a0215414 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 @@ -48,6 +48,11 @@ * @opensearch.internal */ public class InternalStats extends InternalNumericMetricsAggregation.MultiValue implements Stats { + /** + * The metrics for the internal stats + * + * @opensearch.internal + */ enum Metrics { count, @@ -195,6 +200,11 @@ public InternalStats reduce(List aggregations, ReduceContex return new InternalStats(name, count, kahanSummation.value(), min, max, format, getMetadata()); } + /** + * Fields for stats agg + * + * @opensearch.internal + */ static class Fields { public static final String COUNT = "count"; public static final String MIN = "min"; 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 45ce6dc3ead3a..a87564c0a4766 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 @@ -110,6 +110,11 @@ public static double percentileRank(TDigestState state, double value) { return percentileRank * 100; } + /** + * Iter for the TDigest percentile ranks agg + * + * @opensearch.internal + */ public static class Iter implements Iterator { private final double[] values; 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 8cc224f2f08ec..cbcb3f0bbcaff 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 @@ -100,6 +100,11 @@ protected AbstractInternalTDigestPercentiles createReduced( return new InternalTDigestPercentiles(name, keys, merged, keyed, format, metadata); } + /** + * Iter for the TDigest percentiles agg + * + * @opensearch.internal + */ public static class Iter implements Iterator { private final double[] percents; 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 88e292f4d4bd3..d36976d8b703d 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 @@ -41,6 +41,11 @@ */ public interface NumericMetricsAggregation extends Aggregation { + /** + * A single value for the metrics agg + * + * @opensearch.internal + */ interface SingleValue extends NumericMetricsAggregation { double value(); @@ -49,5 +54,10 @@ interface SingleValue extends NumericMetricsAggregation { } + /** + * Multi values in a numeric metrics agg + * + * @opensearch.internal + */ interface MultiValue 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 96d2d525e8386..f90e5a092385f 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 @@ -51,6 +51,11 @@ private NumericMetricsAggregator(String name, SearchContext context, Aggregator super(name, context, parent, metadata); } + /** + * Single numeric metric agg value + * + * @opensearch.internal + */ public abstract static class SingleValue extends NumericMetricsAggregator { protected SingleValue(String name, SearchContext context, Aggregator parent, Map metadata) throws IOException { @@ -75,6 +80,11 @@ public BucketComparator bucketComparator(String key, SortOrder order) { } } + /** + * Multi numeric metric agg value + * + * @opensearch.internal + */ public abstract static class MultiValue extends NumericMetricsAggregator { protected MultiValue(String name, SearchContext context, Aggregator parent, Map metadata) throws IOException { 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 f20cf2eb22350..95b38fcd8cc29 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 @@ -123,6 +123,11 @@ public int hashCode() { return Objects.hash(method); } + /** + * The TDigest + * + * @opensearch.internal + */ public static class TDigest extends PercentilesConfig { static final double DEFAULT_COMPRESSION = 100.0; private double compression; @@ -219,6 +224,11 @@ public int hashCode() { } } + /** + * The HDR value + * + * @opensearch.internal + */ public static class Hdr extends PercentilesConfig { static final int DEFAULT_NUMBER_SIG_FIGS = 3; private int numberOfSignificantValueDigits; 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 2964ede7979cb..414d2e6e99b43 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 @@ -77,6 +77,11 @@ */ class TopHitsAggregator extends MetricsAggregator { + /** + * Collectors for top hits + * + * @opensearch.internal + */ private static class Collectors { public final TopDocsCollector topDocsCollector; public final MaxScoreCollector maxScoreCollector; 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 d7f82f36a3a5e..3d63a31f24705 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 @@ -67,6 +67,8 @@ public class BucketHelpers { * * "insert_zeros": empty buckets will be filled with zeros for all metrics * "skip": empty buckets will simply be ignored + * + * @opensearch.internal */ public enum GapPolicy implements Writeable { INSERT_ZEROS((byte) 0, "insert_zeros"), 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 1fc86dce35390..440d1caddbd9b 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 @@ -153,6 +153,11 @@ public boolean equals(Object obj) { return Objects.equals(alpha, other.alpha); } + /** + * Builder for the EWMA model + * + * @opensearch.internal + */ public static class EWMAModelBuilder implements MovAvgModelBuilder { private double alpha = DEFAULT_ALPHA; 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 510f3396cf8a6..8b94a45b4674f 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 @@ -195,6 +195,11 @@ public boolean equals(Object obj) { return Objects.equals(alpha, other.alpha) && Objects.equals(beta, other.beta); } + /** + * Builder for the holt linear model + * + * @opensearch.internal + */ public static class HoltLinearModelBuilder implements MovAvgModelBuilder { private double alpha = DEFAULT_ALPHA; private double beta = DEFAULT_BETA; 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 1dccb17d78b84..34371a6502d85 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 @@ -63,6 +63,11 @@ public class HoltWintersModel extends MovAvgModel { private static final SeasonalityType DEFAULT_SEASONALITY_TYPE = SeasonalityType.ADDITIVE; private static final boolean DEFAULT_PAD = false; + /** + * The seasonality type + * + * @opensearch.internal + */ public enum SeasonalityType { ADDITIVE((byte) 0, "add"), MULTIPLICATIVE((byte) 1, "mult"); @@ -392,6 +397,11 @@ public boolean equals(Object obj) { && Objects.equals(pad, other.pad); } + /** + * Builder for the holt winters model + * + * @opensearch.internal + */ public static class HoltWintersModelBuilder implements MovAvgModelBuilder { private double alpha = DEFAULT_ALPHA; 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 95028c5a560a5..40c7a5791454c 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 @@ -209,6 +209,11 @@ public int hashCode() { return Objects.hash(super.hashCode(), Arrays.hashCode(percents), Arrays.hashCode(percentiles)); } + /** + * Iterator for the percentiles agg + * + * @opensearch.internal + */ public static class Iter implements Iterator { private final double[] percents; 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 1595c0f5f4514..f1b47730a5542 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 @@ -113,6 +113,11 @@ public MovAvgModel parse(@Nullable Map settings, String pipeline } }; + /** + * Builder for the linear model + * + * @opensearch.internal + */ public static class LinearModelBuilder implements MovAvgModelBuilder { @Override public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { 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 6b7497235efd9..b629be21b764e 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 @@ -158,6 +158,8 @@ protected double[] emptyPredictions(int numPredictions) { /** * Abstract class which also provides some concrete parsing functionality. + * + * @opensearch.internal */ public abstract static class AbstractModelParser { /** 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 ff5a4f254e666..20dd463a3cca7 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 @@ -51,6 +51,11 @@ public abstract class MovingFunctionScript { */ public abstract double execute(Map params, double[] values); + /** + * Factory interface + * + * @opensearch.internal + */ public interface Factory extends ScriptFactory { MovingFunctionScript newInstance(); } 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 da4a3b90b273b..4b1134d9e1a60 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 @@ -57,6 +57,8 @@ public abstract class PipelineAggregator implements NamedWriteable { /** * Parse the {@link PipelineAggregationBuilder} from a {@link XContentParser}. + * + * @opensearch.internal */ @FunctionalInterface public interface Parser { @@ -81,6 +83,8 @@ public interface Parser { /** * Tree of {@link PipelineAggregator}s to modify a tree of aggregations * after their final reduction. + * + * @opensearch.internal */ public static class PipelineTree { /** 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 4336311c82ba2..0850d1eeb4081 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 @@ -112,6 +112,11 @@ public MovAvgModel parse(@Nullable Map settings, String pipeline } }; + /** + * Builder for the simple model + * + * @opensearch.internal + */ public static class SimpleModelBuilder implements MovAvgModelBuilder { @Override public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { 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 d93d80493319a..2bdb561879baa 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 @@ -128,6 +128,11 @@ public static AggregationPath parse(String path) { return new AggregationPath(tokens); } + /** + * Element in an agg path + * + * @opensearch.internal + */ public static class PathElement { private final String fullName; 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 f9b6a91444873..eba64998014e2 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 @@ -49,6 +49,11 @@ public class AggregationUsageService implements ReportingService> aggs; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java b/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java index 8527eaae2ec4b..b7e157b6050fc 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/BaseMultiValuesSourceFieldConfig.java @@ -171,6 +171,11 @@ public String toString() { abstract void doWriteTo(StreamOutput out) throws IOException; + /** + * Base builder for the multi values source field configuration + * + * @opensearch.internal + */ public abstract static class Builder> { String fieldName; Object missing = null; diff --git a/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java b/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java index def1191c70f12..b0c828ca6b902 100644 --- a/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java +++ b/server/src/main/java/org/opensearch/search/aggregations/support/MultiTermsValuesSourceConfig.java @@ -36,6 +36,11 @@ public class MultiTermsValuesSourceConfig extends BaseMultiValuesSourceFieldConf private static final String NAME = "field_config"; public static final ParseField FILTER = new ParseField("filter"); + /** + * Parser supplier function + * + * @opensearch.internal + */ public interface ParserSupplier { ObjectParser apply( Boolean scriptable, @@ -156,6 +161,11 @@ public int hashCode() { return Objects.hash(super.hashCode(), userValueTypeHint, format, includeExclude); } + /** + * Builder for the multi terms values source configuration + * + * @opensearch.internal + */ public static class Builder extends BaseMultiValuesSourceFieldConfig.Builder { private ValueType userValueTypeHint = null; private String format; 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 3ef949c6eebbb..0889a1c90d12d 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 @@ -49,6 +49,11 @@ public abstract class MultiValuesSource { protected Map values; + /** + * Numeric format + * + * @opensearch.internal + */ public static class NumericMultiValuesSource extends MultiValuesSource { public NumericMultiValuesSource(Map valuesSourceConfigs, QueryShardContext context) { values = new HashMap<>(valuesSourceConfigs.size()); 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 7573f69e0833e..a49fd83b9df9f 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 @@ -59,6 +59,11 @@ public abstract class MultiValuesSourceAggregationBuilder> extends AbstractAggregationBuilder { + /** + * Base leaf only class + * + * @opensearch.internal + */ public abstract static class LeafOnly> extends MultiValuesSourceAggregationBuilder< AB> { 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 a7145ac871305..63fce83369c18 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 @@ -130,6 +130,11 @@ public int hashCode() { return Objects.hash(super.hashCode(), filter); } + /** + * Builder for the field config + * + * @opensearch.internal + */ public static class Builder extends BaseMultiValuesSourceFieldConfig.Builder { private QueryBuilder filter = null; 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 9bcf7df85d098..ba9e1fcb3ccc1 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 @@ -103,6 +103,11 @@ public boolean hasGlobalOrdinals() { return false; } + /** + * Range type + * + * @opensearch.internal + */ public static class Range extends ValuesSource { private final RangeType rangeType; protected final IndexFieldData indexFieldData; @@ -134,6 +139,11 @@ public RangeType rangeType() { } } + /** + * Bytes type + * + * @opensearch.internal + */ public abstract static class Bytes extends ValuesSource { @Override @@ -147,6 +157,11 @@ public final Function roundingPreparer(IndexReader throw new AggregationExecutionException("can't round a [BYTES]"); } + /** + * Provides ordinals for bytes + * + * @opensearch.internal + */ public abstract static class WithOrdinals extends Bytes { public static final WithOrdinals EMPTY = new WithOrdinals() { @@ -211,6 +226,11 @@ public long globalMaxOrd(IndexSearcher indexSearcher) throws IOException { } } + /** + * Field data for the bytes values source + * + * @opensearch.internal + */ public static class FieldData extends WithOrdinals { protected final IndexOrdinalsFieldData indexFieldData; @@ -257,6 +277,11 @@ public LongUnaryOperator globalOrdinalsMapping(LeafReaderContext context) throws } } + /** + * Field data without ordinals + * + * @opensearch.internal + */ public static class FieldData extends Bytes { protected final IndexFieldData indexFieldData; @@ -274,6 +299,8 @@ public SortedBinaryDocValues bytesValues(LeafReaderContext context) { /** * {@link ValuesSource} implementation for stand alone scripts returning a Bytes value + * + * @opensearch.internal */ public static class Script extends Bytes { @@ -297,6 +324,8 @@ public boolean needsScores() { // No need to implement ReaderContextAware here, the delegate already takes care of updating data structures /** * {@link ValuesSource} subclass for Bytes fields with a Value Script applied + * + * @opensearch.internal */ public static class WithScript extends Bytes { @@ -318,6 +347,11 @@ public SortedBinaryDocValues bytesValues(LeafReaderContext context) throws IOExc return new BytesValues(delegate.bytesValues(context), script.newInstance(context)); } + /** + * Bytes values + * + * @opensearch.internal + */ static class BytesValues extends SortingBinaryDocValues implements ScorerAware { private final SortedBinaryDocValues bytesValues; @@ -358,6 +392,11 @@ public boolean advanceExact(int doc) throws IOException { } } + /** + * Numeric values source type + * + * @opensearch.internal + */ public abstract static class Numeric extends ValuesSource { public static final Numeric EMPTY = new Numeric() { @@ -411,6 +450,8 @@ public Function roundingPreparer(IndexReader reader) throws /** * {@link ValuesSource} subclass for Numeric fields with a Value Script applied + * + * @opensearch.internal */ public static class WithScript extends Numeric { @@ -447,6 +488,11 @@ public SortedNumericDoubleValues doubleValues(LeafReaderContext context) throws return new DoubleValues(delegate.doubleValues(context), script.newInstance(context)); } + /** + * Long values source type + * + * @opensearch.internal + */ static class LongValues extends AbstractSortingNumericDocValues implements ScorerAware { private final SortedNumericDocValues longValues; @@ -478,6 +524,11 @@ public boolean advanceExact(int target) throws IOException { } } + /** + * Double values source type + * + * @opensearch.internal + */ static class DoubleValues extends SortingNumericDoubleValues implements ScorerAware { private final SortedNumericDoubleValues doubleValues; @@ -510,6 +561,11 @@ public boolean advanceExact(int target) throws IOException { } } + /** + * Field data for numerics + * + * @opensearch.internal + */ public static class FieldData extends Numeric { protected final IndexNumericFieldData indexFieldData; @@ -541,6 +597,8 @@ public SortedNumericDoubleValues doubleValues(LeafReaderContext context) { /** * {@link ValuesSource} implementation for stand alone scripts returning a Numeric value + * + * @opensearch.internal */ public static class Script extends Numeric { private final AggregationScript.LeafFactory script; @@ -579,6 +637,11 @@ public boolean needsScores() { } + /** + * Geo point values source + * + * @opensearch.internal + */ public abstract static class GeoPoint extends ValuesSource { public static final GeoPoint EMPTY = new GeoPoint() { @@ -608,6 +671,11 @@ public final Function roundingPreparer(IndexReader public abstract MultiGeoPointValues geoPointValues(LeafReaderContext context); + /** + * Field data for geo point values source + * + * @opensearch.internal + */ public static class Fielddata extends GeoPoint { protected final IndexGeoPointFieldData indexFieldData; 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 5eb880642b983..52afc6435d562 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 @@ -140,6 +140,11 @@ public static void declareFields( } } + /** + * Base leaf only + * + * @opensearch.internal + */ public abstract static class LeafOnly> extends ValuesSourceAggregationBuilder { 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 430accde5c279..0cb5a12bac4af 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 @@ -53,6 +53,11 @@ */ public class ValuesSourceRegistry { + /** + * The registry key for the values source registry key + * + * @opensearch.internal + */ public static final class RegistryKey { private final String name; private final Class supplierType; @@ -82,6 +87,11 @@ public int hashCode() { public static final RegistryKey UNREGISTERED_KEY = new RegistryKey("unregistered", RegistryKey.class); + /** + * Builder for the values source registry + * + * @opensearch.internal + */ public static class Builder { private final AggregationUsageService.Builder usageServiceBuilder; private Map, List>> aggregatorRegistry = new HashMap<>(); 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 88281b12f47eb..d3b131cf9f792 100644 --- a/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilder.java +++ b/server/src/main/java/org/opensearch/search/builder/SearchSourceBuilder.java @@ -1471,6 +1471,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Boosts on an index + * + * @opensearch.internal + */ public static class IndexBoost implements Writeable, ToXContentObject { private final String index; private final float boost; @@ -1567,6 +1572,11 @@ public boolean equals(Object obj) { } + /** + * Script field + * + * @opensearch.internal + */ public static class ScriptField implements Writeable, ToXContentFragment { private final boolean ignoreFailure; diff --git a/server/src/main/java/org/opensearch/search/fetch/FetchSubPhase.java b/server/src/main/java/org/opensearch/search/fetch/FetchSubPhase.java index 744505ec98c68..fa30b2a5c7450 100644 --- a/server/src/main/java/org/opensearch/search/fetch/FetchSubPhase.java +++ b/server/src/main/java/org/opensearch/search/fetch/FetchSubPhase.java @@ -47,6 +47,11 @@ */ public interface FetchSubPhase { + /** + * The hit context for the fetch subphase + * + * @opensearch.internal + */ class HitContext { private final SearchHit hit; private final LeafReaderContext readerContext; diff --git a/server/src/main/java/org/opensearch/search/fetch/subphase/ScriptFieldsContext.java b/server/src/main/java/org/opensearch/search/fetch/subphase/ScriptFieldsContext.java index 04bbe9457661c..78c35098d9cc4 100644 --- a/server/src/main/java/org/opensearch/search/fetch/subphase/ScriptFieldsContext.java +++ b/server/src/main/java/org/opensearch/search/fetch/subphase/ScriptFieldsContext.java @@ -44,6 +44,11 @@ */ public class ScriptFieldsContext { + /** + * Script field use in the script fields context + * + * @opensearch.internal + */ public static class ScriptField { private final String name; private final FieldScript.LeafFactory script; diff --git a/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java b/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java index 7c2cc5ae1def3..a8a7d290c827e 100644 --- a/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java +++ b/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightBuilder.java @@ -469,6 +469,11 @@ public HighlightBuilder rewrite(QueryRewriteContext ctx) throws IOException { } + /** + * Field for highlight builder + * + * @opensearch.internal + */ public static class Field extends AbstractHighlighterBuilder { static final NamedObjectParser PARSER; static { @@ -572,6 +577,11 @@ public Field rewrite(QueryRewriteContext ctx) throws IOException { } } + /** + * Order for highlight builder + * + * @opensearch.internal + */ public enum Order implements Writeable { NONE, SCORE; @@ -598,6 +608,11 @@ public String toString() { } } + /** + * Boundary scanner type + * + * @opensearch.internal + */ public enum BoundaryScannerType implements Writeable { CHARS, WORD, diff --git a/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightUtils.java b/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightUtils.java index e37d56b1f86b2..7a358b7e4b252 100644 --- a/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightUtils.java +++ b/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/HighlightUtils.java @@ -80,6 +80,11 @@ public static List loadFieldValues( return fetcher.fetchValues(hitContext.sourceLookup()); } + /** + * Encoders for the highlighters + * + * @opensearch.internal + */ public static class Encoders { public static final Encoder DEFAULT = new DefaultEncoder(); public static final Encoder HTML = new SimpleHTMLEncoder(); diff --git a/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/SearchHighlightContext.java b/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/SearchHighlightContext.java index 6072c738d9d80..33a5397ae964b 100644 --- a/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/SearchHighlightContext.java +++ b/server/src/main/java/org/opensearch/search/fetch/subphase/highlight/SearchHighlightContext.java @@ -79,6 +79,11 @@ public boolean forceSource(Field field) { return _field == null ? false : _field.fieldOptions.forceSource; } + /** + * Field for the search highlight context + * + * @opensearch.internal + */ public static class Field { private final String field; private final FieldOptions fieldOptions; @@ -99,6 +104,11 @@ public FieldOptions fieldOptions() { } } + /** + * Field options for the search highlight context + * + * @opensearch.internal + */ public static class FieldOptions { // Field options that default to null or -1 are often set to their real default in HighlighterParseElement#parse diff --git a/server/src/main/java/org/opensearch/search/query/QueryPhase.java b/server/src/main/java/org/opensearch/search/query/QueryPhase.java index 0b935baf6419b..340a32e914e08 100644 --- a/server/src/main/java/org/opensearch/search/query/QueryPhase.java +++ b/server/src/main/java/org/opensearch/search/query/QueryPhase.java @@ -388,6 +388,8 @@ private static boolean canEarlyTerminate(IndexReader reader, SortAndFormats sort /** * The exception being raised when search timeout is reached. + * + * @opensearch.internal */ public static class TimeExceededException extends RuntimeException { private static final long serialVersionUID = 1L; @@ -395,6 +397,8 @@ public static class TimeExceededException extends RuntimeException { /** * Default {@link QueryPhaseSearcher} implementation which delegates to the {@link QueryPhase}. + * + * @opensearch.internal */ public static class DefaultQueryPhaseSearcher implements QueryPhaseSearcher { /** diff --git a/server/src/main/java/org/opensearch/search/rescore/QueryRescorer.java b/server/src/main/java/org/opensearch/search/rescore/QueryRescorer.java index afd897ef49aa7..008bff18cea5b 100644 --- a/server/src/main/java/org/opensearch/search/rescore/QueryRescorer.java +++ b/server/src/main/java/org/opensearch/search/rescore/QueryRescorer.java @@ -184,6 +184,11 @@ private TopDocs combine(TopDocs in, TopDocs resorted, QueryRescoreContext ctx) { return in; } + /** + * Context used during query rescoring + * + * @opensearch.internal + */ public static class QueryRescoreContext extends RescoreContext { private Query query; private float queryWeight = 1.0f; diff --git a/server/src/main/java/org/opensearch/search/sort/BucketedSort.java b/server/src/main/java/org/opensearch/search/sort/BucketedSort.java index b6b5c58502063..9266469db2b05 100644 --- a/server/src/main/java/org/opensearch/search/sort/BucketedSort.java +++ b/server/src/main/java/org/opensearch/search/sort/BucketedSort.java @@ -98,6 +98,8 @@ public abstract class BucketedSort implements Releasable { /** * Callbacks for storing extra data along with competitive sorts. + * + * @opensearch.internal */ public interface ExtraData { /** @@ -115,6 +117,11 @@ public interface ExtraData { */ Loader loader(LeafReaderContext ctx) throws IOException; + /** + * Loader for extra data + * + * @opensearch.internal + */ @FunctionalInterface interface Loader { /** @@ -185,6 +192,8 @@ public int getBucketSize() { /** * Used with {@link BucketedSort#getValues(long, ResultBuilder)} to * build results from the sorting operation. + * + * @opensearch.internal */ @FunctionalInterface public interface ResultBuilder { @@ -532,6 +541,11 @@ protected final void swap(long lhs, long rhs) { values.set(rhs, tmp); } + /** + * Leaf for doubles + * + * @opensearch.internal + */ protected abstract class Leaf extends BucketedSort.Leaf { protected Leaf(LeafReaderContext ctx) { super(ctx); @@ -625,6 +639,11 @@ protected final void swap(long lhs, long rhs) { values.set(rhs, tmp); } + /** + * Leaf for floats + * + * @opensearch.internal + */ protected abstract class Leaf extends BucketedSort.Leaf { protected Leaf(LeafReaderContext ctx) { super(ctx); @@ -704,6 +723,11 @@ protected final void swap(long lhs, long rhs) { values.set(rhs, tmp); } + /** + * Leaf for bucketed sort + * + * @opensearch.internal + */ protected abstract class Leaf extends BucketedSort.Leaf { protected Leaf(LeafReaderContext ctx) { super(ctx); diff --git a/server/src/main/java/org/opensearch/search/sort/ScriptSortBuilder.java b/server/src/main/java/org/opensearch/search/sort/ScriptSortBuilder.java index 6a412eb3b5e2b..685284dfe99ff 100644 --- a/server/src/main/java/org/opensearch/search/sort/ScriptSortBuilder.java +++ b/server/src/main/java/org/opensearch/search/sort/ScriptSortBuilder.java @@ -460,6 +460,11 @@ public String getWriteableName() { return NAME; } + /** + * Sort type for scripting + * + * @opensearch.internal + */ public enum ScriptSortType implements Writeable { /** script sort for a string value **/ STRING, diff --git a/server/src/main/java/org/opensearch/search/suggest/SuggestionSearchContext.java b/server/src/main/java/org/opensearch/search/suggest/SuggestionSearchContext.java index 9b38c73692eda..f0d8efc64b6b3 100644 --- a/server/src/main/java/org/opensearch/search/suggest/SuggestionSearchContext.java +++ b/server/src/main/java/org/opensearch/search/suggest/SuggestionSearchContext.java @@ -55,6 +55,11 @@ public Map suggestions() { return suggestions; } + /** + * The suggestion context + * + * @opensearch.internal + */ public abstract static class SuggestionContext { private BytesRef text; diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/CompletionSuggestion.java b/server/src/main/java/org/opensearch/search/suggest/completion/CompletionSuggestion.java index e8245d46a6231..95133585f99d9 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/CompletionSuggestion.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/CompletionSuggestion.java @@ -256,6 +256,11 @@ protected Entry newEntry(StreamInput in) throws IOException { return new Entry(in); } + /** + * Entry in the completion suggester + * + * @opensearch.internal + */ public static final class Entry extends Suggest.Suggestion.Entry { public Entry(Text text, int offset, int length) { @@ -287,6 +292,11 @@ public static Entry fromXContent(XContentParser parser) { return PARSER.apply(parser, null); } + /** + * Options for the completion suggester + * + * @opensearch.internal + */ public static class Option extends Suggest.Suggestion.Entry.Option { private final Map> contexts; private final ScoreDoc doc; diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/FuzzyOptions.java b/server/src/main/java/org/opensearch/search/suggest/completion/FuzzyOptions.java index 6c4a71a00e07a..af7a07af58d45 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/FuzzyOptions.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/FuzzyOptions.java @@ -220,6 +220,8 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws /** * Options for fuzzy queries + * + * @opensearch.internal */ public static class Builder { diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/RegexOptions.java b/server/src/main/java/org/opensearch/search/suggest/completion/RegexOptions.java index fc33eda23a423..d832dc9d8d5d8 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/RegexOptions.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/RegexOptions.java @@ -155,6 +155,8 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws /** * Options for regular expression queries + * + * @opensearch.internal */ public static class Builder { private int flagsValue = RegExp.ALL; diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryContextMapping.java b/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryContextMapping.java index 624e828d78b83..dbefaff2b1ac9 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryContextMapping.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryContextMapping.java @@ -219,6 +219,8 @@ public int hashCode() { /** * Builder for {@link CategoryContextMapping} + * + * @opensearch.internal */ public static class Builder extends ContextBuilder { diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryQueryContext.java b/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryQueryContext.java index bc31e88587870..5a1b218eab510 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryQueryContext.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/context/CategoryQueryContext.java @@ -151,6 +151,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Builder for the category query context + * + * @opensearch.internal + */ public static class Builder { private String category; private boolean isPrefix = false; diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/context/ContextMapping.java b/server/src/main/java/org/opensearch/search/suggest/completion/context/ContextMapping.java index 3492da40edd77..6b6588e125fe0 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/context/ContextMapping.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/context/ContextMapping.java @@ -67,6 +67,11 @@ public abstract class ContextMapping implements ToXContent protected final Type type; protected final String name; + /** + * Type of context mapping + * + * @opensearch.internal + */ public enum Type { CATEGORY, GEO; @@ -189,6 +194,11 @@ public String toString() { } } + /** + * The internal query context + * + * @opensearch.internal + */ public static class InternalQueryContext { public final String context; public final int boost; diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoContextMapping.java b/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoContextMapping.java index f191e371d672f..e3b809dc57b83 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoContextMapping.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoContextMapping.java @@ -363,6 +363,11 @@ public int hashCode() { return Objects.hash(super.hashCode(), precision, fieldName); } + /** + * Builder for geo context mapping + * + * @opensearch.internal + */ public static class Builder extends ContextBuilder { private int precision = DEFAULT_PRECISION; diff --git a/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoQueryContext.java b/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoQueryContext.java index d47c79747a841..b362d01304e22 100644 --- a/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoQueryContext.java +++ b/server/src/main/java/org/opensearch/search/suggest/completion/context/GeoQueryContext.java @@ -177,6 +177,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws return builder; } + /** + * Builder for the geo context + * + * @opensearch.internal + */ public static class Builder { private GeoPoint geoPoint; private int boost = 1; diff --git a/server/src/main/java/org/opensearch/search/suggest/phrase/DirectCandidateGenerator.java b/server/src/main/java/org/opensearch/search/suggest/phrase/DirectCandidateGenerator.java index c8ca01d6991cb..cbf1d332dfa1b 100644 --- a/server/src/main/java/org/opensearch/search/suggest/phrase/DirectCandidateGenerator.java +++ b/server/src/main/java/org/opensearch/search/suggest/phrase/DirectCandidateGenerator.java @@ -278,6 +278,11 @@ int thresholdTermFrequency(int docFreq) { return 0; } + /** + * Token consumer for a direct candidate + * + * @opensearch.internal + */ public abstract static class TokenConsumer { protected CharTermAttribute charTermAttr; protected PositionIncrementAttribute posIncAttr; @@ -299,6 +304,11 @@ protected BytesRef fillBytesRef(BytesRefBuilder spare) { public void end() {} } + /** + * Candidate set of terms + * + * @opensearch.internal + */ public static class CandidateSet { public Candidate[] candidates; public final Candidate originalTerm; @@ -328,6 +338,11 @@ public void addOneCandidate(Candidate candidate) { } + /** + * Candidate term + * + * @opensearch.internal + */ public static class Candidate implements Comparable { public static final Candidate[] EMPTY = new Candidate[0]; public final BytesRef term; diff --git a/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestion.java b/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestion.java index 648d00e350976..4a2ff2388c04d 100644 --- a/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestion.java +++ b/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestion.java @@ -87,6 +87,11 @@ public static PhraseSuggestion fromXContent(XContentParser parser, String name) return suggestion; } + /** + * Entry in the phrase suggester + * + * @opensearch.internal + */ public static class Entry extends Suggestion.Entry { protected double cutoffScore = Double.MIN_VALUE; @@ -170,6 +175,11 @@ public int hashCode() { return Objects.hash(super.hashCode(), cutoffScore); } + /** + * Options for phrase suggestion + * + * @opensearch.internal + */ public static class Option extends Suggestion.Entry.Option { public Option(Text text, Text highlighted, float score, Boolean collateMatch) { diff --git a/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestionBuilder.java b/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestionBuilder.java index ca9effe722297..dd9046e182cc2 100644 --- a/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestionBuilder.java +++ b/server/src/main/java/org/opensearch/search/suggest/phrase/PhraseSuggestionBuilder.java @@ -772,6 +772,8 @@ protected int doHashCode() { /** * {@link CandidateGenerator} interface. + * + * @opensearch.internal */ public interface CandidateGenerator extends Writeable, ToXContentObject { String getType(); diff --git a/server/src/main/java/org/opensearch/search/suggest/phrase/WordScorer.java b/server/src/main/java/org/opensearch/search/suggest/phrase/WordScorer.java index 4a32aee83b36e..184e3828b06e5 100644 --- a/server/src/main/java/org/opensearch/search/suggest/phrase/WordScorer.java +++ b/server/src/main/java/org/opensearch/search/suggest/phrase/WordScorer.java @@ -133,6 +133,11 @@ public static BytesRef join(BytesRef separator, BytesRefBuilder result, BytesRef return result.get(); } + /** + * Factory for a new scorer + * + * @opensearch.internal + */ public interface WordScorerFactory { WordScorer newScorer(IndexReader reader, Terms terms, String field, double realWordLikelihood, BytesRef separator) throws IOException; diff --git a/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestion.java b/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestion.java index 78d0e8f58e6a5..d7d0b57213c15 100644 --- a/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestion.java +++ b/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestion.java @@ -79,8 +79,12 @@ public TermSuggestion(StreamInput in) throws IOException { } } - // Same behaviour as comparators in suggest module, but for SuggestedWord - // Highest score first, then highest freq first, then lowest term first + /** + * Same behaviour as comparators in suggest module, but for SuggestedWord + * Highest score first, then highest freq first, then lowest term first + * + * @opensearch.internal + */ public static class Score implements Comparator { @Override @@ -94,8 +98,12 @@ public int compare(Suggestion.Entry.Option first, Suggestion.Entry.Option second } } - // Same behaviour as comparators in suggest module, but for SuggestedWord - // Highest freq first, then highest score first, then lowest term first + /** + * Same behaviour as comparators in suggest module, but for SuggestedWord + * Highest freq first, then highest score first, then lowest term first + * + * @opensearch.internal + */ public static class Frequency implements Comparator { @Override @@ -181,6 +189,8 @@ public int hashCode() { /** * Represents a part from the suggest text with suggested options. + * + * @opensearch.internal */ public static class Entry extends Suggest.Suggestion.Entry { @@ -215,6 +225,8 @@ public static Entry fromXContent(XContentParser parser) { /** * Contains the suggested text with its document frequency and score. + * + * @opensearch.internal */ public static class Option extends Suggest.Suggestion.Entry.Option { diff --git a/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestionBuilder.java b/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestionBuilder.java index 27916ef03e9b1..e53c27596e5fd 100644 --- a/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestionBuilder.java +++ b/server/src/main/java/org/opensearch/search/suggest/term/TermSuggestionBuilder.java @@ -512,7 +512,11 @@ protected int doHashCode() { ); } - /** An enum representing the valid suggest modes. */ + /** + * An enum representing the valid suggest modes. + * + * @opensearch.internal + */ public enum SuggestMode implements Writeable { /** Only suggest terms in the suggest text that aren't in the index. This is the default. */ MISSING { @@ -553,7 +557,11 @@ public static SuggestMode resolve(final String str) { public abstract org.apache.lucene.search.spell.SuggestMode toLucene(); } - /** An enum representing the valid string edit distance algorithms for determining suggestions. */ + /** + * An enum representing the valid string edit distance algorithms for determining suggestions. + * + * @opensearch.internal + */ public enum StringDistanceImpl implements Writeable { /** This is the default and is based on damerau_levenshtein, but highly optimized * for comparing string distance for terms inside the index. */