diff --git a/server/src/main/java/org/opensearch/index/AbstractIndexComponent.java b/server/src/main/java/org/opensearch/index/AbstractIndexComponent.java index e63216494a5b2..88809156174c0 100644 --- a/server/src/main/java/org/opensearch/index/AbstractIndexComponent.java +++ b/server/src/main/java/org/opensearch/index/AbstractIndexComponent.java @@ -36,6 +36,11 @@ import org.opensearch.common.logging.DeprecationLogger; import org.opensearch.common.logging.Loggers; +/** + * A base class for new index components + * + * @opensearch.internal + */ public abstract class AbstractIndexComponent implements IndexComponent { protected final Logger logger; diff --git a/server/src/main/java/org/opensearch/index/CompositeIndexEventListener.java b/server/src/main/java/org/opensearch/index/CompositeIndexEventListener.java index 79c97d1126e93..3b5ff7798e0de 100644 --- a/server/src/main/java/org/opensearch/index/CompositeIndexEventListener.java +++ b/server/src/main/java/org/opensearch/index/CompositeIndexEventListener.java @@ -51,6 +51,8 @@ /** * A composite {@link IndexEventListener} that forwards all callbacks to an immutable list of IndexEventListener + * + * @opensearch.internal */ final class CompositeIndexEventListener implements IndexEventListener { diff --git a/server/src/main/java/org/opensearch/index/Index.java b/server/src/main/java/org/opensearch/index/Index.java index 5284bc7d23c71..db620592d1ede 100644 --- a/server/src/main/java/org/opensearch/index/Index.java +++ b/server/src/main/java/org/opensearch/index/Index.java @@ -47,6 +47,8 @@ /** * A value class representing the basic required properties of an OpenSearch index. + * + * @opensearch.internal */ public class Index implements Writeable, ToXContentObject { diff --git a/server/src/main/java/org/opensearch/index/IndexComponent.java b/server/src/main/java/org/opensearch/index/IndexComponent.java index 16387e7cfb80c..2a4555b66df13 100644 --- a/server/src/main/java/org/opensearch/index/IndexComponent.java +++ b/server/src/main/java/org/opensearch/index/IndexComponent.java @@ -32,6 +32,11 @@ package org.opensearch.index; +/** + * Actions that can be executed on an Index Component + * + * @opensearch.internal + */ public interface IndexComponent { Index index(); diff --git a/server/src/main/java/org/opensearch/index/IndexModule.java b/server/src/main/java/org/opensearch/index/IndexModule.java index 61f6c9689308f..acceee7562068 100644 --- a/server/src/main/java/org/opensearch/index/IndexModule.java +++ b/server/src/main/java/org/opensearch/index/IndexModule.java @@ -109,6 +109,8 @@ *
  • Settings update listener - Custom settings update listener can be registered via * {@link #addSettingsUpdateConsumer(Setting, Consumer)}
    • * + * + * @opensearch.internal */ public final class IndexModule { diff --git a/server/src/main/java/org/opensearch/index/IndexNotFoundException.java b/server/src/main/java/org/opensearch/index/IndexNotFoundException.java index f4c8f38844efd..120e7f955cd9c 100644 --- a/server/src/main/java/org/opensearch/index/IndexNotFoundException.java +++ b/server/src/main/java/org/opensearch/index/IndexNotFoundException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if an index is not found + * + * @opensearch.internal + */ public final class IndexNotFoundException extends ResourceNotFoundException { /** * Construct with a custom message. diff --git a/server/src/main/java/org/opensearch/index/IndexService.java b/server/src/main/java/org/opensearch/index/IndexService.java index 1b301e85365ba..54aa7f5097d61 100644 --- a/server/src/main/java/org/opensearch/index/IndexService.java +++ b/server/src/main/java/org/opensearch/index/IndexService.java @@ -122,6 +122,11 @@ import static java.util.Collections.unmodifiableMap; import static org.opensearch.common.collect.MapBuilder.newMapBuilder; +/** + * The main OpenSearch index service + * + * @opensearch.internal + */ public class IndexService extends AbstractIndexComponent implements IndicesClusterStateService.AllocatedIndex { private final IndexEventListener eventListener; diff --git a/server/src/main/java/org/opensearch/index/IndexSettings.java b/server/src/main/java/org/opensearch/index/IndexSettings.java index 8ba9c47902115..e40acb94ee498 100644 --- a/server/src/main/java/org/opensearch/index/IndexSettings.java +++ b/server/src/main/java/org/opensearch/index/IndexSettings.java @@ -69,6 +69,8 @@ * the latest updated settings instance. Classes that need to listen to settings updates can register * a settings consumer at index creation via {@link IndexModule#addSettingsUpdateConsumer(Setting, Consumer)} that will * be called for each settings update. + * + * @opensearch.internal */ public final class IndexSettings { public static final Setting> DEFAULT_FIELD_SETTING = Setting.listSetting( diff --git a/server/src/main/java/org/opensearch/index/IndexSortConfig.java b/server/src/main/java/org/opensearch/index/IndexSortConfig.java index 99cf5d2d6091c..3acc80e519785 100644 --- a/server/src/main/java/org/opensearch/index/IndexSortConfig.java +++ b/server/src/main/java/org/opensearch/index/IndexSortConfig.java @@ -69,6 +69,7 @@ * * * + * @opensearch.internal **/ public final class IndexSortConfig { /** diff --git a/server/src/main/java/org/opensearch/index/IndexWarmer.java b/server/src/main/java/org/opensearch/index/IndexWarmer.java index 8a728101fb78c..5251b49539ecb 100644 --- a/server/src/main/java/org/opensearch/index/IndexWarmer.java +++ b/server/src/main/java/org/opensearch/index/IndexWarmer.java @@ -54,6 +54,11 @@ import java.util.concurrent.Executor; import java.util.concurrent.TimeUnit; +/** + * The main opensearch index warmer + * + * @opensearch.internal + */ public final class IndexWarmer { private static final Logger logger = LogManager.getLogger(IndexWarmer.class); diff --git a/server/src/main/java/org/opensearch/index/IndexingPressure.java b/server/src/main/java/org/opensearch/index/IndexingPressure.java index af5c1827e3c6b..a100f0b76f996 100644 --- a/server/src/main/java/org/opensearch/index/IndexingPressure.java +++ b/server/src/main/java/org/opensearch/index/IndexingPressure.java @@ -45,6 +45,11 @@ import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; +/** + * Tracks indexing memory pressure + * + * @opensearch.internal + */ public class IndexingPressure { public static final Setting MAX_INDEXING_BYTES = Setting.memorySizeSetting( diff --git a/server/src/main/java/org/opensearch/index/IndexingPressureService.java b/server/src/main/java/org/opensearch/index/IndexingPressureService.java index 9044c5942e8cb..8abc0172d7c6f 100644 --- a/server/src/main/java/org/opensearch/index/IndexingPressureService.java +++ b/server/src/main/java/org/opensearch/index/IndexingPressureService.java @@ -18,6 +18,8 @@ /** * Sets up classes for node/shard level indexing pressure. * Provides abstraction and orchestration for indexing pressure interfaces when called from Transport Actions or for Stats. + * + * @opensearch.internal */ public class IndexingPressureService { diff --git a/server/src/main/java/org/opensearch/index/IndexingSlowLog.java b/server/src/main/java/org/opensearch/index/IndexingSlowLog.java index b77e7639152fb..c45d3f6b34d65 100644 --- a/server/src/main/java/org/opensearch/index/IndexingSlowLog.java +++ b/server/src/main/java/org/opensearch/index/IndexingSlowLog.java @@ -55,6 +55,11 @@ import java.util.Map; import java.util.concurrent.TimeUnit; +/** + * The indexing slowlog implementation + * + * @opensearch.internal + */ public final class IndexingSlowLog implements IndexingOperationListener { public static final String INDEX_INDEXING_SLOWLOG_PREFIX = "index.indexing.slowlog"; public static final Setting INDEX_INDEXING_SLOWLOG_THRESHOLD_INDEX_WARN_SETTING = Setting.timeSetting( diff --git a/server/src/main/java/org/opensearch/index/MergePolicyConfig.java b/server/src/main/java/org/opensearch/index/MergePolicyConfig.java index 26d2588e3f240..9ff19a94bbabd 100644 --- a/server/src/main/java/org/opensearch/index/MergePolicyConfig.java +++ b/server/src/main/java/org/opensearch/index/MergePolicyConfig.java @@ -121,6 +121,8 @@ * indices segments API to see the segments that an index has, and * possibly either increase the max_merged_segment or issue an optimize * call for the index (try and aim to issue it on a low traffic time). + * + * @opensearch.internal */ public final class MergePolicyConfig { diff --git a/server/src/main/java/org/opensearch/index/MergeSchedulerConfig.java b/server/src/main/java/org/opensearch/index/MergeSchedulerConfig.java index df3c76fea0ea6..9e170b448d641 100644 --- a/server/src/main/java/org/opensearch/index/MergeSchedulerConfig.java +++ b/server/src/main/java/org/opensearch/index/MergeSchedulerConfig.java @@ -63,6 +63,8 @@ * throttled, while an application doing heavy indexing will see the throttle * move higher to allow merges to keep up with ongoing indexing. * + * + * @opensearch.internal */ public final class MergeSchedulerConfig { diff --git a/server/src/main/java/org/opensearch/index/OpenSearchTieredMergePolicy.java b/server/src/main/java/org/opensearch/index/OpenSearchTieredMergePolicy.java index 0289e96b356be..637282374de73 100644 --- a/server/src/main/java/org/opensearch/index/OpenSearchTieredMergePolicy.java +++ b/server/src/main/java/org/opensearch/index/OpenSearchTieredMergePolicy.java @@ -44,6 +44,8 @@ * Wrapper around {@link TieredMergePolicy} which doesn't respect * {@link TieredMergePolicy#setMaxMergedSegmentMB(double)} on forced merges. * See https://issues.apache.org/jira/browse/LUCENE-7976. + * + * @opensearch.internal */ final class OpenSearchTieredMergePolicy extends FilterMergePolicy { diff --git a/server/src/main/java/org/opensearch/index/SearchSlowLog.java b/server/src/main/java/org/opensearch/index/SearchSlowLog.java index 37413388215c8..c48c122580579 100644 --- a/server/src/main/java/org/opensearch/index/SearchSlowLog.java +++ b/server/src/main/java/org/opensearch/index/SearchSlowLog.java @@ -53,6 +53,11 @@ import java.util.concurrent.TimeUnit; import java.util.stream.Stream; +/** + * The search time slow log implementation + * + * @opensearch.internal + */ public final class SearchSlowLog implements SearchOperationListener { private static final Charset UTF_8 = Charset.forName("UTF-8"); diff --git a/server/src/main/java/org/opensearch/index/ShardIndexingPressure.java b/server/src/main/java/org/opensearch/index/ShardIndexingPressure.java index 881ede2f6903f..59dde20c9a904 100644 --- a/server/src/main/java/org/opensearch/index/ShardIndexingPressure.java +++ b/server/src/main/java/org/opensearch/index/ShardIndexingPressure.java @@ -39,6 +39,8 @@ * 1. Memory Accounting at shard level. This can be enabled/disabled based on dynamic setting. * 2. Memory Accounting at Node level. Tracking is done using the IndexingPressure artefacts to support feature seamless toggling. * 3. Interfaces to access the statistics for shard trackers. + * + * @opensearch.internal */ public class ShardIndexingPressure extends IndexingPressure { diff --git a/server/src/main/java/org/opensearch/index/ShardIndexingPressureMemoryManager.java b/server/src/main/java/org/opensearch/index/ShardIndexingPressureMemoryManager.java index fff0649a4327f..d64740488ce31 100644 --- a/server/src/main/java/org/opensearch/index/ShardIndexingPressureMemoryManager.java +++ b/server/src/main/java/org/opensearch/index/ShardIndexingPressureMemoryManager.java @@ -52,6 +52,7 @@ * goes above operating_factor.upper of current shard limits. MemoryManager attempts to update the new shard limit such that the new value * remains withing the operating_factor.optimal range of current shard utilization. * + * @opensearch.internal */ public class ShardIndexingPressureMemoryManager { private static final Logger logger = LogManager.getLogger(ShardIndexingPressureMemoryManager.class); diff --git a/server/src/main/java/org/opensearch/index/ShardIndexingPressureSettings.java b/server/src/main/java/org/opensearch/index/ShardIndexingPressureSettings.java index b1fa1f0bd3b65..35e93162788b5 100644 --- a/server/src/main/java/org/opensearch/index/ShardIndexingPressureSettings.java +++ b/server/src/main/java/org/opensearch/index/ShardIndexingPressureSettings.java @@ -14,6 +14,8 @@ * This class contains all the settings which are required and owned by {TODO link ShardIndexingPressure}. These will be * referenced/used in ShardIndexingPressure, as well as its dependent components, i.e. * {TODO link ShardIndexingPressureMemoryManager} and {TODO link ShardIndexingPressureStore} + * + * @opensearch.internal */ public final class ShardIndexingPressureSettings { diff --git a/server/src/main/java/org/opensearch/index/ShardIndexingPressureStore.java b/server/src/main/java/org/opensearch/index/ShardIndexingPressureStore.java index bcc883a569f25..f634365676b18 100644 --- a/server/src/main/java/org/opensearch/index/ShardIndexingPressureStore.java +++ b/server/src/main/java/org/opensearch/index/ShardIndexingPressureStore.java @@ -44,6 +44,7 @@ * update and evict operations can be abstracted out to support any other strategy such as LRU, if * discovered a need later. * + * @opensearch.internal */ public class ShardIndexingPressureStore { diff --git a/server/src/main/java/org/opensearch/index/ShardIndexingPressureTracker.java b/server/src/main/java/org/opensearch/index/ShardIndexingPressureTracker.java index e63425eef825c..c6031d80fa0a8 100644 --- a/server/src/main/java/org/opensearch/index/ShardIndexingPressureTracker.java +++ b/server/src/main/java/org/opensearch/index/ShardIndexingPressureTracker.java @@ -31,6 +31,8 @@ * increase the complexity of handling shard-lister events and handling other race scenarios such as request-draining etc. * To prefer simplicity we have modelled by keeping explicit fields for different operation tracking, while tracker by itself is * agnostic of the actual shard role. + * + * @opensearch.internal */ public class ShardIndexingPressureTracker { diff --git a/server/src/main/java/org/opensearch/index/SlowLogLevel.java b/server/src/main/java/org/opensearch/index/SlowLogLevel.java index ca628aba14d18..0a28edd59d491 100644 --- a/server/src/main/java/org/opensearch/index/SlowLogLevel.java +++ b/server/src/main/java/org/opensearch/index/SlowLogLevel.java @@ -33,6 +33,11 @@ import java.util.Locale; +/** + * Levels for the slow logs + * + * @opensearch.internal + */ public enum SlowLogLevel { WARN(3), // most specific - little logging INFO(2), diff --git a/server/src/main/java/org/opensearch/index/VersionType.java b/server/src/main/java/org/opensearch/index/VersionType.java index 54ad2c7292eb7..0eb6dfa8fc53a 100644 --- a/server/src/main/java/org/opensearch/index/VersionType.java +++ b/server/src/main/java/org/opensearch/index/VersionType.java @@ -39,6 +39,11 @@ import java.io.IOException; import java.util.Locale; +/** + * Types of index versions + * + * @opensearch.internal + */ public enum VersionType implements Writeable { INTERNAL((byte) 0) { @Override diff --git a/server/src/main/java/org/opensearch/index/analysis/AbstractCharFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/AbstractCharFilterFactory.java index d632b3db3dcb4..dcc03252e4901 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AbstractCharFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/AbstractCharFilterFactory.java @@ -35,6 +35,11 @@ import org.opensearch.index.AbstractIndexComponent; import org.opensearch.index.IndexSettings; +/** + * Base character filter factory used in analysis chain + * + * @opensearch.internal + */ public abstract class AbstractCharFilterFactory extends AbstractIndexComponent implements CharFilterFactory { private final String name; diff --git a/server/src/main/java/org/opensearch/index/analysis/AbstractIndexAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/AbstractIndexAnalyzerProvider.java index e1c5fd0ba3c64..b21c972944d4f 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AbstractIndexAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/AbstractIndexAnalyzerProvider.java @@ -37,6 +37,11 @@ import org.opensearch.index.AbstractIndexComponent; import org.opensearch.index.IndexSettings; +/** + * Base analyzer component + * + * @opensearch.internal + */ public abstract class AbstractIndexAnalyzerProvider extends AbstractIndexComponent implements AnalyzerProvider { private final String name; diff --git a/server/src/main/java/org/opensearch/index/analysis/AbstractTokenFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/AbstractTokenFilterFactory.java index fb465eb273382..e5ccd9a0c3f1a 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AbstractTokenFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/AbstractTokenFilterFactory.java @@ -36,6 +36,11 @@ import org.opensearch.index.AbstractIndexComponent; import org.opensearch.index.IndexSettings; +/** + * Base tokenfilter factory used in analysis chain + * + * @opensearch.internal + */ public abstract class AbstractTokenFilterFactory extends AbstractIndexComponent implements TokenFilterFactory { private final String name; diff --git a/server/src/main/java/org/opensearch/index/analysis/AbstractTokenizerFactory.java b/server/src/main/java/org/opensearch/index/analysis/AbstractTokenizerFactory.java index 9a0f4196bab16..fce420a5e424d 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AbstractTokenizerFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/AbstractTokenizerFactory.java @@ -36,6 +36,11 @@ import org.opensearch.index.AbstractIndexComponent; import org.opensearch.index.IndexSettings; +/** + * Base tokenizer factory used in analysis chain + * + * @opensearch.internal + */ public abstract class AbstractTokenizerFactory extends AbstractIndexComponent implements TokenizerFactory { private final String name; diff --git a/server/src/main/java/org/opensearch/index/analysis/Analysis.java b/server/src/main/java/org/opensearch/index/analysis/Analysis.java index 90bb21cfc0a4b..9fe5abcb3ea9d 100644 --- a/server/src/main/java/org/opensearch/index/analysis/Analysis.java +++ b/server/src/main/java/org/opensearch/index/analysis/Analysis.java @@ -88,6 +88,11 @@ import static java.util.Collections.unmodifiableMap; +/** + * Core analysis class + * + * @opensearch.internal + */ public class Analysis { public static CharArraySet parseStemExclusion(Settings settings, CharArraySet defaultStemExclusion) { diff --git a/server/src/main/java/org/opensearch/index/analysis/AnalysisMode.java b/server/src/main/java/org/opensearch/index/analysis/AnalysisMode.java index a94820499040e..4385680d9eb93 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AnalysisMode.java +++ b/server/src/main/java/org/opensearch/index/analysis/AnalysisMode.java @@ -36,6 +36,8 @@ * Enum representing the mode in which token filters and analyzers are allowed to operate. * While most token filters are allowed both in index and search time analyzers, some are * restricted to be used only at index time, others at search time. + * + * @opensearch.internal */ public enum AnalysisMode { diff --git a/server/src/main/java/org/opensearch/index/analysis/AnalysisRegistry.java b/server/src/main/java/org/opensearch/index/analysis/AnalysisRegistry.java index dc0e7b13eeb7e..07041978c812c 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AnalysisRegistry.java +++ b/server/src/main/java/org/opensearch/index/analysis/AnalysisRegistry.java @@ -67,6 +67,8 @@ /** * An internal registry for tokenizer, token filter, char filter and analyzer. * This class exists per node and allows to create per-index {@link IndexAnalyzers} via {@link #build(IndexSettings)} + * + * @opensearch.internal */ public final class AnalysisRegistry implements Closeable { public static final String INDEX_ANALYSIS_CHAR_FILTER = "index.analysis.char_filter"; diff --git a/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponents.java b/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponents.java index 9fd36fdee4c6c..97e31c480572a 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponents.java +++ b/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponents.java @@ -41,6 +41,8 @@ /** * A class that groups analysis components necessary to produce a custom analyzer. * See {@link ReloadableCustomAnalyzer} for an example usage. + * + * @opensearch.internal */ public final class AnalyzerComponents { diff --git a/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponentsProvider.java b/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponentsProvider.java index 305fc84178c19..0fe720a01e5a6 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponentsProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/AnalyzerComponentsProvider.java @@ -34,6 +34,8 @@ /** * Analyzers that provide access to their token filters should implement this + * + * @opensearch.internal */ public interface AnalyzerComponentsProvider { diff --git a/server/src/main/java/org/opensearch/index/analysis/AnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/AnalyzerProvider.java index e4a0c8b73b7f1..24ddabca16f1e 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/AnalyzerProvider.java @@ -35,6 +35,11 @@ import org.apache.lucene.analysis.Analyzer; import org.opensearch.common.inject.Provider; +/** + * Base interface for all analyzer providers + * + * @opensearch.internal + */ public interface AnalyzerProvider extends Provider { String name(); diff --git a/server/src/main/java/org/opensearch/index/analysis/AnalyzerScope.java b/server/src/main/java/org/opensearch/index/analysis/AnalyzerScope.java index c61c1283c160f..0ee51b32aab46 100644 --- a/server/src/main/java/org/opensearch/index/analysis/AnalyzerScope.java +++ b/server/src/main/java/org/opensearch/index/analysis/AnalyzerScope.java @@ -32,6 +32,11 @@ package org.opensearch.index.analysis; +/** + * Enum to identify the scope of an analyzer + * + * @opensearch.internal + */ public enum AnalyzerScope { INDEX, INDICES, diff --git a/server/src/main/java/org/opensearch/index/analysis/CharFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/CharFilterFactory.java index 6d0ce067e5c48..dc9d3704b1a3c 100644 --- a/server/src/main/java/org/opensearch/index/analysis/CharFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/CharFilterFactory.java @@ -34,6 +34,11 @@ import java.io.Reader; +/** + * Base character filter factory behavior used in analysis chain + * + * @opensearch.internal + */ public interface CharFilterFactory { String name(); diff --git a/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzer.java b/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzer.java index 5971516520bbf..8db5c89d75808 100644 --- a/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzer.java +++ b/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzer.java @@ -39,6 +39,11 @@ import java.io.Reader; +/** + * Custom analyzer chain + * + * @opensearch.internal + */ public final class CustomAnalyzer extends Analyzer implements AnalyzerComponentsProvider { private final AnalyzerComponents components; diff --git a/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzerProvider.java index f300d7ad4330f..f339b6fc302bf 100644 --- a/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/CustomAnalyzerProvider.java @@ -44,6 +44,8 @@ /** * A custom analyzer that is built out of a single {@link org.apache.lucene.analysis.Tokenizer} and a list * of {@link org.apache.lucene.analysis.TokenFilter}s. + * + * @opensearch.internal */ public class CustomAnalyzerProvider extends AbstractIndexAnalyzerProvider { diff --git a/server/src/main/java/org/opensearch/index/analysis/CustomNormalizerProvider.java b/server/src/main/java/org/opensearch/index/analysis/CustomNormalizerProvider.java index 4957ff4471f38..69c0cf418eece 100644 --- a/server/src/main/java/org/opensearch/index/analysis/CustomNormalizerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/CustomNormalizerProvider.java @@ -43,6 +43,8 @@ * A custom normalizer that is built out of a char and token filters. On the * contrary to analyzers, it does not support tokenizers and only supports a * subset of char and token filters. + * + * @opensearch.internal */ public final class CustomNormalizerProvider extends AbstractIndexAnalyzerProvider { diff --git a/server/src/main/java/org/opensearch/index/analysis/FieldNameAnalyzer.java b/server/src/main/java/org/opensearch/index/analysis/FieldNameAnalyzer.java index 26d1bf3ce73ca..14d4e89ab33b7 100644 --- a/server/src/main/java/org/opensearch/index/analysis/FieldNameAnalyzer.java +++ b/server/src/main/java/org/opensearch/index/analysis/FieldNameAnalyzer.java @@ -38,6 +38,11 @@ import java.util.Map; +/** + * Analysis chain for field names + * + * @opensearch.internal + */ public final class FieldNameAnalyzer extends DelegatingAnalyzerWrapper { private final Map analyzers; diff --git a/server/src/main/java/org/opensearch/index/analysis/HunspellTokenFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/HunspellTokenFilterFactory.java index d195cbb57810a..dcfb77a90481d 100644 --- a/server/src/main/java/org/opensearch/index/analysis/HunspellTokenFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/HunspellTokenFilterFactory.java @@ -40,6 +40,11 @@ import java.util.Locale; +/** + * The token filter factory for the hunspell analyzer + * + * @opensearch.internal + */ public class HunspellTokenFilterFactory extends AbstractTokenFilterFactory { private final Dictionary dictionary; diff --git a/server/src/main/java/org/opensearch/index/analysis/IndexAnalyzers.java b/server/src/main/java/org/opensearch/index/analysis/IndexAnalyzers.java index a1c8f02765155..07be53d668b5e 100644 --- a/server/src/main/java/org/opensearch/index/analysis/IndexAnalyzers.java +++ b/server/src/main/java/org/opensearch/index/analysis/IndexAnalyzers.java @@ -51,6 +51,8 @@ * access to individual tokenizers, char or token filter. * * @see AnalysisRegistry + * + * @opensearch.internal */ public final class IndexAnalyzers implements Closeable { private final Map analyzers; diff --git a/server/src/main/java/org/opensearch/index/analysis/KeywordAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/KeywordAnalyzerProvider.java index 61580d07e1ba7..04ed3cf74f0ec 100644 --- a/server/src/main/java/org/opensearch/index/analysis/KeywordAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/KeywordAnalyzerProvider.java @@ -37,6 +37,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Provider for the keyword analyzer + * + * @opensearch.internal + */ public class KeywordAnalyzerProvider extends AbstractIndexAnalyzerProvider { private final KeywordAnalyzer keywordAnalyzer; diff --git a/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizer.java b/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizer.java index 4e9f1acfc530a..ca90244366da8 100644 --- a/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizer.java +++ b/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizer.java @@ -38,7 +38,11 @@ import org.apache.lucene.analysis.Tokenizer; import org.apache.lucene.analysis.core.KeywordTokenizer; -/** Normalizer used to lowercase values */ +/** + * Normalizer used to lowercase values + * + * @opensearch.internal + */ public final class LowercaseNormalizer extends Analyzer { @Override diff --git a/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizerProvider.java b/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizerProvider.java index 6b1f63b08ac70..bd6dce7ba69e9 100644 --- a/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/LowercaseNormalizerProvider.java @@ -38,6 +38,8 @@ /** * Builds an analyzer for normalization that lowercases terms. + * + * @opensearch.internal */ public class LowercaseNormalizerProvider extends AbstractIndexAnalyzerProvider { diff --git a/server/src/main/java/org/opensearch/index/analysis/NameOrDefinition.java b/server/src/main/java/org/opensearch/index/analysis/NameOrDefinition.java index c10a1ea66ac85..905c4c18589e3 100644 --- a/server/src/main/java/org/opensearch/index/analysis/NameOrDefinition.java +++ b/server/src/main/java/org/opensearch/index/analysis/NameOrDefinition.java @@ -45,6 +45,11 @@ import java.util.Map; import java.util.Objects; +/** + * Provides the name and settings for an analyzer + * + * @opensearch.internal + */ public class NameOrDefinition implements Writeable, ToXContentFragment { // exactly one of these two members is not null public final String name; diff --git a/server/src/main/java/org/opensearch/index/analysis/NamedAnalyzer.java b/server/src/main/java/org/opensearch/index/analysis/NamedAnalyzer.java index 5ee904f196e2c..2a88d375a7df8 100644 --- a/server/src/main/java/org/opensearch/index/analysis/NamedAnalyzer.java +++ b/server/src/main/java/org/opensearch/index/analysis/NamedAnalyzer.java @@ -43,6 +43,8 @@ /** * Named analyzer is an analyzer wrapper around an actual analyzer ({@link #analyzer} that is associated * with a name ({@link #name()}. + * + * @opensearch.internal */ public class NamedAnalyzer extends DelegatingAnalyzerWrapper { diff --git a/server/src/main/java/org/opensearch/index/analysis/NormalizingCharFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/NormalizingCharFilterFactory.java index e907800896dd3..ab8d23339029c 100644 --- a/server/src/main/java/org/opensearch/index/analysis/NormalizingCharFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/NormalizingCharFilterFactory.java @@ -39,6 +39,8 @@ * * The default implementation of {@link #normalize(Reader)} delegates to * {@link #create(Reader)} + * + * @opensearch.internal */ public interface NormalizingCharFilterFactory extends CharFilterFactory { diff --git a/server/src/main/java/org/opensearch/index/analysis/NormalizingTokenFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/NormalizingTokenFilterFactory.java index 3cd6b6e0afd5d..be761aee0d36c 100644 --- a/server/src/main/java/org/opensearch/index/analysis/NormalizingTokenFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/NormalizingTokenFilterFactory.java @@ -39,6 +39,8 @@ * * The default implementation delegates {@link #normalize(TokenStream)} to * {@link #create(TokenStream)}}. + * + * @opensearch.internal */ public interface NormalizingTokenFilterFactory extends TokenFilterFactory { diff --git a/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProvider.java index ababa4a616efb..a6b4540760653 100644 --- a/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProvider.java @@ -34,6 +34,11 @@ import org.apache.lucene.analysis.Analyzer; +/** + * Provider for all prebuilt analyzers + * + * @opensearch.internal + */ public class PreBuiltAnalyzerProvider implements AnalyzerProvider { private final NamedAnalyzer analyzer; diff --git a/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProviderFactory.java b/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProviderFactory.java index d2c5384153bd2..ce1489d5de70c 100644 --- a/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProviderFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/PreBuiltAnalyzerProviderFactory.java @@ -49,6 +49,11 @@ import java.util.function.Supplier; import java.util.stream.Collectors; +/** + * Factory to create the providers for all prebuilt analyzers + * + * @opensearch.internal + */ public class PreBuiltAnalyzerProviderFactory extends PreConfiguredAnalysisComponent> implements Closeable { private final Function create; diff --git a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredAnalysisComponent.java b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredAnalysisComponent.java index 95437a2a8ef30..a9c3c95c7bb77 100644 --- a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredAnalysisComponent.java +++ b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredAnalysisComponent.java @@ -43,6 +43,8 @@ /** * Shared implementation for pre-configured analysis components. + * + * @opensearch.internal */ public abstract class PreConfiguredAnalysisComponent implements AnalysisModule.AnalysisProvider { protected final String name; diff --git a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredCharFilter.java b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredCharFilter.java index a7faba4e4a7d8..6ba23ed67beed 100644 --- a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredCharFilter.java +++ b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredCharFilter.java @@ -43,6 +43,8 @@ /** * Provides pre-configured, shared {@link CharFilter}s. + * + * @opensearch.internal */ public class PreConfiguredCharFilter extends PreConfiguredAnalysisComponent { /** diff --git a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenFilter.java b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenFilter.java index 23621f6c6480d..9fb8623994162 100644 --- a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenFilter.java +++ b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenFilter.java @@ -43,6 +43,8 @@ /** * Provides pre-configured, shared {@link TokenFilter}s. + * + * @opensearch.internal */ public final class PreConfiguredTokenFilter extends PreConfiguredAnalysisComponent { /** diff --git a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenizer.java b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenizer.java index 428f386526813..50ff0a55add77 100644 --- a/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenizer.java +++ b/server/src/main/java/org/opensearch/index/analysis/PreConfiguredTokenizer.java @@ -42,6 +42,8 @@ /** * Provides pre-configured, shared {@link Tokenizer}s. + * + * @opensearch.internal */ public final class PreConfiguredTokenizer extends PreConfiguredAnalysisComponent { /** diff --git a/server/src/main/java/org/opensearch/index/analysis/ReloadableCustomAnalyzer.java b/server/src/main/java/org/opensearch/index/analysis/ReloadableCustomAnalyzer.java index bd12f15693fbd..ba8996eb9c17b 100644 --- a/server/src/main/java/org/opensearch/index/analysis/ReloadableCustomAnalyzer.java +++ b/server/src/main/java/org/opensearch/index/analysis/ReloadableCustomAnalyzer.java @@ -42,6 +42,11 @@ import java.io.Reader; import java.util.Map; +/** + * A custom analyzer that is reloadable + * + * @opensearch.internal + */ public final class ReloadableCustomAnalyzer extends Analyzer implements AnalyzerComponentsProvider { private volatile AnalyzerComponents components; diff --git a/server/src/main/java/org/opensearch/index/analysis/ShingleTokenFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/ShingleTokenFilterFactory.java index 863c4b2611d66..953479e3e0a19 100644 --- a/server/src/main/java/org/opensearch/index/analysis/ShingleTokenFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/ShingleTokenFilterFactory.java @@ -41,6 +41,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Factory for shingle analyzer token filters + * + * @opensearch.internal + */ public class ShingleTokenFilterFactory extends AbstractTokenFilterFactory { private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(ShingleTokenFilterFactory.class); diff --git a/server/src/main/java/org/opensearch/index/analysis/SimpleAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/SimpleAnalyzerProvider.java index 85d25aaa753e6..67b95a2849581 100644 --- a/server/src/main/java/org/opensearch/index/analysis/SimpleAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/SimpleAnalyzerProvider.java @@ -37,6 +37,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Provider class for the simple analyzer + * + * @opensearch.internal + */ public class SimpleAnalyzerProvider extends AbstractIndexAnalyzerProvider { private final SimpleAnalyzer simpleAnalyzer; diff --git a/server/src/main/java/org/opensearch/index/analysis/StandardAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/StandardAnalyzerProvider.java index 1cdcb5af12c78..d7fe1bd9987b3 100644 --- a/server/src/main/java/org/opensearch/index/analysis/StandardAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/StandardAnalyzerProvider.java @@ -38,6 +38,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Provider for the standard analyzer + * + * @opensearch.internal + */ public class StandardAnalyzerProvider extends AbstractIndexAnalyzerProvider { private final StandardAnalyzer standardAnalyzer; diff --git a/server/src/main/java/org/opensearch/index/analysis/StandardTokenizerFactory.java b/server/src/main/java/org/opensearch/index/analysis/StandardTokenizerFactory.java index 4cb5b52280dfb..076be2497b98c 100644 --- a/server/src/main/java/org/opensearch/index/analysis/StandardTokenizerFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/StandardTokenizerFactory.java @@ -39,6 +39,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Tokenizer factory for the standard analyzer + * + * @opensearch.internal + */ public class StandardTokenizerFactory extends AbstractTokenizerFactory { private final int maxTokenLength; diff --git a/server/src/main/java/org/opensearch/index/analysis/StopAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/StopAnalyzerProvider.java index 84381c21cb8b4..41044d2afccf8 100644 --- a/server/src/main/java/org/opensearch/index/analysis/StopAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/StopAnalyzerProvider.java @@ -39,6 +39,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Provider class for the stop word analyzer + * + * @opensearch.internal + */ public class StopAnalyzerProvider extends AbstractIndexAnalyzerProvider { private final StopAnalyzer stopAnalyzer; diff --git a/server/src/main/java/org/opensearch/index/analysis/StopTokenFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/StopTokenFilterFactory.java index 05787c1f4d95c..7ed0ec06a7c5f 100644 --- a/server/src/main/java/org/opensearch/index/analysis/StopTokenFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/StopTokenFilterFactory.java @@ -43,6 +43,11 @@ import java.util.Set; +/** + * Token filter factory for the stop word analyzer + * + * @opensearch.internal + */ public class StopTokenFilterFactory extends AbstractTokenFilterFactory { private final CharArraySet stopWords; diff --git a/server/src/main/java/org/opensearch/index/analysis/TokenFilterFactory.java b/server/src/main/java/org/opensearch/index/analysis/TokenFilterFactory.java index 3468fca095ed6..1b9d781b177ce 100644 --- a/server/src/main/java/org/opensearch/index/analysis/TokenFilterFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/TokenFilterFactory.java @@ -39,6 +39,11 @@ import java.util.List; import java.util.function.Function; +/** + * Base token filter factory used in analysis chain + * + * @opensearch.internal + */ public interface TokenFilterFactory { String name(); diff --git a/server/src/main/java/org/opensearch/index/analysis/TokenizerFactory.java b/server/src/main/java/org/opensearch/index/analysis/TokenizerFactory.java index d38c1f9c3027a..b667175e89b4a 100644 --- a/server/src/main/java/org/opensearch/index/analysis/TokenizerFactory.java +++ b/server/src/main/java/org/opensearch/index/analysis/TokenizerFactory.java @@ -36,6 +36,11 @@ import java.util.function.Supplier; +/** + * Base tokenizer factory used in analysis chain + * + * @opensearch.internal + */ public interface TokenizerFactory { String name(); diff --git a/server/src/main/java/org/opensearch/index/analysis/WhitespaceAnalyzerProvider.java b/server/src/main/java/org/opensearch/index/analysis/WhitespaceAnalyzerProvider.java index 63425af2d23f5..038b9168745da 100644 --- a/server/src/main/java/org/opensearch/index/analysis/WhitespaceAnalyzerProvider.java +++ b/server/src/main/java/org/opensearch/index/analysis/WhitespaceAnalyzerProvider.java @@ -37,6 +37,11 @@ import org.opensearch.env.Environment; import org.opensearch.index.IndexSettings; +/** + * Provider class for the whitespace analyzer + * + * @opensearch.internal + */ public class WhitespaceAnalyzerProvider extends AbstractIndexAnalyzerProvider { private final WhitespaceAnalyzer analyzer; diff --git a/server/src/main/java/org/opensearch/index/cache/IndexCache.java b/server/src/main/java/org/opensearch/index/cache/IndexCache.java index ff8be98cd8ab4..0423a0bfd2706 100644 --- a/server/src/main/java/org/opensearch/index/cache/IndexCache.java +++ b/server/src/main/java/org/opensearch/index/cache/IndexCache.java @@ -41,6 +41,11 @@ import java.io.Closeable; import java.io.IOException; +/** + * Wrapping class for the index cache + * + * @opensearch.internal + */ public class IndexCache extends AbstractIndexComponent implements Closeable { private final QueryCache queryCache; diff --git a/server/src/main/java/org/opensearch/index/cache/bitset/BitsetFilterCache.java b/server/src/main/java/org/opensearch/index/cache/bitset/BitsetFilterCache.java index 0bc77f0f0079b..12306f942d32f 100644 --- a/server/src/main/java/org/opensearch/index/cache/bitset/BitsetFilterCache.java +++ b/server/src/main/java/org/opensearch/index/cache/bitset/BitsetFilterCache.java @@ -84,6 +84,8 @@ * Use this cache with care, only components that require that a filter is to be materialized as a {@link BitDocIdSet} * and require that it should always be around should use this cache, otherwise the * {@link org.opensearch.index.cache.query.QueryCache} should be used instead. + * + * @opensearch.internal */ public final class BitsetFilterCache extends AbstractIndexComponent implements diff --git a/server/src/main/java/org/opensearch/index/cache/bitset/ShardBitsetFilterCache.java b/server/src/main/java/org/opensearch/index/cache/bitset/ShardBitsetFilterCache.java index 3ddadc0cdedba..025bfe6bab666 100644 --- a/server/src/main/java/org/opensearch/index/cache/bitset/ShardBitsetFilterCache.java +++ b/server/src/main/java/org/opensearch/index/cache/bitset/ShardBitsetFilterCache.java @@ -37,6 +37,11 @@ import org.opensearch.index.shard.AbstractIndexShardComponent; import org.opensearch.index.shard.ShardId; +/** + * Bitset Filter Cache for shards + * + * @opensearch.internal + */ public class ShardBitsetFilterCache extends AbstractIndexShardComponent { private final CounterMetric totalMetric = new CounterMetric(); diff --git a/server/src/main/java/org/opensearch/index/cache/query/DisabledQueryCache.java b/server/src/main/java/org/opensearch/index/cache/query/DisabledQueryCache.java index 8a25f731adb03..493d8a4bbcd98 100644 --- a/server/src/main/java/org/opensearch/index/cache/query/DisabledQueryCache.java +++ b/server/src/main/java/org/opensearch/index/cache/query/DisabledQueryCache.java @@ -37,6 +37,11 @@ import org.opensearch.index.AbstractIndexComponent; import org.opensearch.index.IndexSettings; +/** + * NoOp Implementation for a Disabled query cache + * + * @opensearch.internal + */ public class DisabledQueryCache extends AbstractIndexComponent implements QueryCache { public DisabledQueryCache(IndexSettings indexSettings) { diff --git a/server/src/main/java/org/opensearch/index/cache/query/IndexQueryCache.java b/server/src/main/java/org/opensearch/index/cache/query/IndexQueryCache.java index b410f8d83df8c..c69f0b8da068f 100644 --- a/server/src/main/java/org/opensearch/index/cache/query/IndexQueryCache.java +++ b/server/src/main/java/org/opensearch/index/cache/query/IndexQueryCache.java @@ -42,6 +42,8 @@ /** * The index-level query cache. This class mostly delegates to the node-level * query cache: {@link IndicesQueryCache}. + * + * @opensearch.internal */ public class IndexQueryCache extends AbstractIndexComponent implements QueryCache { diff --git a/server/src/main/java/org/opensearch/index/cache/query/QueryCache.java b/server/src/main/java/org/opensearch/index/cache/query/QueryCache.java index fe38c61dfe54c..384f66fcfc132 100644 --- a/server/src/main/java/org/opensearch/index/cache/query/QueryCache.java +++ b/server/src/main/java/org/opensearch/index/cache/query/QueryCache.java @@ -36,6 +36,11 @@ import java.io.Closeable; +/** + * Base interface for a query cache + * + * @opensearch.internal + */ public interface QueryCache extends IndexComponent, Closeable, org.apache.lucene.search.QueryCache { void clear(String reason); diff --git a/server/src/main/java/org/opensearch/index/cache/query/QueryCacheStats.java b/server/src/main/java/org/opensearch/index/cache/query/QueryCacheStats.java index 9dcae1f93d537..e9cc26c378749 100644 --- a/server/src/main/java/org/opensearch/index/cache/query/QueryCacheStats.java +++ b/server/src/main/java/org/opensearch/index/cache/query/QueryCacheStats.java @@ -43,6 +43,11 @@ import java.io.IOException; +/** + * Stats for the query cache + * + * @opensearch.internal + */ public class QueryCacheStats implements Writeable, ToXContentFragment { private long ramBytesUsed; diff --git a/server/src/main/java/org/opensearch/index/cache/request/RequestCacheStats.java b/server/src/main/java/org/opensearch/index/cache/request/RequestCacheStats.java index f48f442af1390..d03bfdad24226 100644 --- a/server/src/main/java/org/opensearch/index/cache/request/RequestCacheStats.java +++ b/server/src/main/java/org/opensearch/index/cache/request/RequestCacheStats.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Request for the query cache statistics + * + * @opensearch.internal + */ public class RequestCacheStats implements Writeable, ToXContentFragment { private long memorySize; diff --git a/server/src/main/java/org/opensearch/index/cache/request/ShardRequestCache.java b/server/src/main/java/org/opensearch/index/cache/request/ShardRequestCache.java index 5fb6d48c74c87..e0ab80777c82d 100644 --- a/server/src/main/java/org/opensearch/index/cache/request/ShardRequestCache.java +++ b/server/src/main/java/org/opensearch/index/cache/request/ShardRequestCache.java @@ -38,6 +38,8 @@ /** * Tracks the portion of the request cache in use for a particular shard. + * + * @opensearch.internal */ public final class ShardRequestCache { diff --git a/server/src/main/java/org/opensearch/index/codec/CodecService.java b/server/src/main/java/org/opensearch/index/codec/CodecService.java index e445ad88f497e..908330858399e 100644 --- a/server/src/main/java/org/opensearch/index/codec/CodecService.java +++ b/server/src/main/java/org/opensearch/index/codec/CodecService.java @@ -47,6 +47,8 @@ * codec layer that allows to use use-case specific file formats & * data-structures per field. OpenSearch exposes the full * {@link Codec} capabilities through this {@link CodecService}. + * + * @opensearch.internal */ public class CodecService { diff --git a/server/src/main/java/org/opensearch/index/codec/CodecServiceConfig.java b/server/src/main/java/org/opensearch/index/codec/CodecServiceConfig.java index 313c0d359bb02..5fa9261471acf 100644 --- a/server/src/main/java/org/opensearch/index/codec/CodecServiceConfig.java +++ b/server/src/main/java/org/opensearch/index/codec/CodecServiceConfig.java @@ -17,6 +17,8 @@ /** * The configuration parameters necessary for the {@link CodecService} instance construction. + * + * @opensearch.internal */ public final class CodecServiceConfig { private final IndexSettings indexSettings; diff --git a/server/src/main/java/org/opensearch/index/codec/CodecServiceFactory.java b/server/src/main/java/org/opensearch/index/codec/CodecServiceFactory.java index da28c5f06b035..8f60d1a045330 100644 --- a/server/src/main/java/org/opensearch/index/codec/CodecServiceFactory.java +++ b/server/src/main/java/org/opensearch/index/codec/CodecServiceFactory.java @@ -10,6 +10,8 @@ /** * A factory for creating new {@link CodecService} instance + * + * @opensearch.internal */ @FunctionalInterface public interface CodecServiceFactory { diff --git a/server/src/main/java/org/opensearch/index/codec/PerFieldMappingPostingFormatCodec.java b/server/src/main/java/org/opensearch/index/codec/PerFieldMappingPostingFormatCodec.java index fa01390d13419..52e940a25ddd6 100644 --- a/server/src/main/java/org/opensearch/index/codec/PerFieldMappingPostingFormatCodec.java +++ b/server/src/main/java/org/opensearch/index/codec/PerFieldMappingPostingFormatCodec.java @@ -50,6 +50,8 @@ * allows users to change the low level postings format for individual fields * per index in real time via the mapping API. If no specific postings format is * configured for a specific field the default postings format is used. + * + * @opensearch.internal */ public class PerFieldMappingPostingFormatCodec extends Lucene91Codec { private final Logger logger; diff --git a/server/src/main/java/org/opensearch/index/engine/CombinedDeletionPolicy.java b/server/src/main/java/org/opensearch/index/engine/CombinedDeletionPolicy.java index 09e6599b33409..8772724c2353d 100644 --- a/server/src/main/java/org/opensearch/index/engine/CombinedDeletionPolicy.java +++ b/server/src/main/java/org/opensearch/index/engine/CombinedDeletionPolicy.java @@ -56,6 +56,8 @@ *

    * In particular, this policy will delete index commits whose max sequence number is at most * the current global checkpoint except the index commit which has the highest max sequence number among those. + * + * @opensearch.internal */ public class CombinedDeletionPolicy extends IndexDeletionPolicy { private final Logger logger; diff --git a/server/src/main/java/org/opensearch/index/engine/CombinedDocValues.java b/server/src/main/java/org/opensearch/index/engine/CombinedDocValues.java index 043e4f2d5661f..0f8ca53429a81 100644 --- a/server/src/main/java/org/opensearch/index/engine/CombinedDocValues.java +++ b/server/src/main/java/org/opensearch/index/engine/CombinedDocValues.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Doc Values used in LuceneChangesSnapshot for recovery + * + * @opensearch.internal + */ final class CombinedDocValues { private final NumericDocValues versionDV; private final NumericDocValues seqNoDV; diff --git a/server/src/main/java/org/opensearch/index/engine/CommitStats.java b/server/src/main/java/org/opensearch/index/engine/CommitStats.java index 1220208d3a8f3..1faed2cd16713 100644 --- a/server/src/main/java/org/opensearch/index/engine/CommitStats.java +++ b/server/src/main/java/org/opensearch/index/engine/CommitStats.java @@ -44,7 +44,11 @@ import java.util.Base64; import java.util.Map; -/** a class the returns dynamic information with respect to the last commit point of this shard */ +/** + * a class the returns dynamic information with respect to the last commit point of this shard + * + * @opensearch.internal + */ public final class CommitStats implements Writeable, ToXContentFragment { private final Map userData; diff --git a/server/src/main/java/org/opensearch/index/engine/CompletionStatsCache.java b/server/src/main/java/org/opensearch/index/engine/CompletionStatsCache.java index b37572a280b4c..08ede10f3f6aa 100644 --- a/server/src/main/java/org/opensearch/index/engine/CompletionStatsCache.java +++ b/server/src/main/java/org/opensearch/index/engine/CompletionStatsCache.java @@ -49,6 +49,11 @@ import java.util.function.Supplier; +/** + * Cache to store engine completion stats + * + * @opensearch.internal + */ class CompletionStatsCache implements ReferenceManager.RefreshListener { private final Supplier searcherSupplier; diff --git a/server/src/main/java/org/opensearch/index/engine/DeleteVersionValue.java b/server/src/main/java/org/opensearch/index/engine/DeleteVersionValue.java index 8ee700428bcb4..9926f3762626f 100644 --- a/server/src/main/java/org/opensearch/index/engine/DeleteVersionValue.java +++ b/server/src/main/java/org/opensearch/index/engine/DeleteVersionValue.java @@ -34,7 +34,11 @@ import org.apache.lucene.util.RamUsageEstimator; -/** Holds a deleted version, which just adds a timestamp to {@link VersionValue} so we know when we can expire the deletion. */ +/** + * Holds a deleted version, which just adds a timestamp to {@link VersionValue} so we know when we can expire the deletion. + * + * @opensearch.internal + */ final class DeleteVersionValue extends VersionValue { diff --git a/server/src/main/java/org/opensearch/index/engine/DocumentMissingException.java b/server/src/main/java/org/opensearch/index/engine/DocumentMissingException.java index 9eb54292e13bd..7cb35b8279153 100644 --- a/server/src/main/java/org/opensearch/index/engine/DocumentMissingException.java +++ b/server/src/main/java/org/opensearch/index/engine/DocumentMissingException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if a document is missing + * + * @opensearch.internal + */ public class DocumentMissingException extends EngineException { public DocumentMissingException(ShardId shardId, String id) { diff --git a/server/src/main/java/org/opensearch/index/engine/DocumentSourceMissingException.java b/server/src/main/java/org/opensearch/index/engine/DocumentSourceMissingException.java index 333abc3794a5c..b3826d9933776 100644 --- a/server/src/main/java/org/opensearch/index/engine/DocumentSourceMissingException.java +++ b/server/src/main/java/org/opensearch/index/engine/DocumentSourceMissingException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if a document source is missing + * + * @opensearch.internal + */ public class DocumentSourceMissingException extends EngineException { public DocumentSourceMissingException(ShardId shardId, String id) { diff --git a/server/src/main/java/org/opensearch/index/engine/Engine.java b/server/src/main/java/org/opensearch/index/engine/Engine.java index 83da0ea6b52f3..06ceb34ab2065 100644 --- a/server/src/main/java/org/opensearch/index/engine/Engine.java +++ b/server/src/main/java/org/opensearch/index/engine/Engine.java @@ -112,6 +112,11 @@ import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_PRIMARY_TERM; import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_SEQ_NO; +/** + * Base OpenSearch Engine class + * + * @opensearch.internal + */ public abstract class Engine implements Closeable { public static final String SYNC_COMMIT_ID = "sync_id"; // TODO: remove sync_id in 3.0 diff --git a/server/src/main/java/org/opensearch/index/engine/EngineConfig.java b/server/src/main/java/org/opensearch/index/engine/EngineConfig.java index d1085b01a3707..52dff2826657b 100644 --- a/server/src/main/java/org/opensearch/index/engine/EngineConfig.java +++ b/server/src/main/java/org/opensearch/index/engine/EngineConfig.java @@ -62,10 +62,12 @@ import java.util.function.LongSupplier; import java.util.function.Supplier; -/* +/** * Holds all the configuration that is used to create an {@link Engine}. * Once {@link Engine} has been created with this object, changes to this * object will affect the {@link Engine} instance. + * + * @opensearch.internal */ public final class EngineConfig { private final ShardId shardId; diff --git a/server/src/main/java/org/opensearch/index/engine/EngineConfigFactory.java b/server/src/main/java/org/opensearch/index/engine/EngineConfigFactory.java index a78a5e5a4820a..afab57905a9a7 100644 --- a/server/src/main/java/org/opensearch/index/engine/EngineConfigFactory.java +++ b/server/src/main/java/org/opensearch/index/engine/EngineConfigFactory.java @@ -42,6 +42,8 @@ /** * A factory to create an EngineConfig based on custom plugin overrides + * + * @opensearch.internal */ public class EngineConfigFactory { private final CodecServiceFactory codecServiceFactory; diff --git a/server/src/main/java/org/opensearch/index/engine/EngineCreationFailureException.java b/server/src/main/java/org/opensearch/index/engine/EngineCreationFailureException.java index f228694cae7d4..b7ea337f271d1 100644 --- a/server/src/main/java/org/opensearch/index/engine/EngineCreationFailureException.java +++ b/server/src/main/java/org/opensearch/index/engine/EngineCreationFailureException.java @@ -40,7 +40,7 @@ /** * An exception indicating that an {@link Engine} creation failed. * - * + * @opensearch.internal */ public class EngineCreationFailureException extends EngineException { diff --git a/server/src/main/java/org/opensearch/index/engine/EngineException.java b/server/src/main/java/org/opensearch/index/engine/EngineException.java index bda9b433e5f40..309f287833bb9 100644 --- a/server/src/main/java/org/opensearch/index/engine/EngineException.java +++ b/server/src/main/java/org/opensearch/index/engine/EngineException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception if there are any errors in the engine + * + * @opensearch.internal + */ public class EngineException extends OpenSearchException { public EngineException(ShardId shardId, String msg, Object... params) { diff --git a/server/src/main/java/org/opensearch/index/engine/EngineFactory.java b/server/src/main/java/org/opensearch/index/engine/EngineFactory.java index f38e5242e2f9c..ced02ab3041c9 100644 --- a/server/src/main/java/org/opensearch/index/engine/EngineFactory.java +++ b/server/src/main/java/org/opensearch/index/engine/EngineFactory.java @@ -33,6 +33,8 @@ /** * Simple Engine Factory + * + * @opensearch.internal */ @FunctionalInterface public interface EngineFactory { diff --git a/server/src/main/java/org/opensearch/index/engine/FlushFailedEngineException.java b/server/src/main/java/org/opensearch/index/engine/FlushFailedEngineException.java index 711fe50f3faee..35d8db66be9ff 100644 --- a/server/src/main/java/org/opensearch/index/engine/FlushFailedEngineException.java +++ b/server/src/main/java/org/opensearch/index/engine/FlushFailedEngineException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if there is an error on flush + * + * @opensearch.internal + */ public class FlushFailedEngineException extends EngineException { public FlushFailedEngineException(ShardId shardId, Throwable t) { diff --git a/server/src/main/java/org/opensearch/index/engine/IndexVersionValue.java b/server/src/main/java/org/opensearch/index/engine/IndexVersionValue.java index 1b10385929380..803d106a2f25e 100644 --- a/server/src/main/java/org/opensearch/index/engine/IndexVersionValue.java +++ b/server/src/main/java/org/opensearch/index/engine/IndexVersionValue.java @@ -37,6 +37,11 @@ import java.util.Objects; +/** + * Encapsulates an Index Version in the translog + * + * @opensearch.internal + */ final class IndexVersionValue extends VersionValue { private static final long RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(IndexVersionValue.class); diff --git a/server/src/main/java/org/opensearch/index/engine/InternalEngine.java b/server/src/main/java/org/opensearch/index/engine/InternalEngine.java index 8e5308973ae64..70165adb6da60 100644 --- a/server/src/main/java/org/opensearch/index/engine/InternalEngine.java +++ b/server/src/main/java/org/opensearch/index/engine/InternalEngine.java @@ -136,6 +136,11 @@ import java.util.stream.Collectors; import java.util.stream.Stream; +/** + * The default internal engine (can be overridden by plugins) + * + * @opensearch.internal + */ public class InternalEngine extends Engine { /** diff --git a/server/src/main/java/org/opensearch/index/engine/InternalEngineFactory.java b/server/src/main/java/org/opensearch/index/engine/InternalEngineFactory.java index 541c4bb047cd9..d17b417832313 100644 --- a/server/src/main/java/org/opensearch/index/engine/InternalEngineFactory.java +++ b/server/src/main/java/org/opensearch/index/engine/InternalEngineFactory.java @@ -32,6 +32,11 @@ package org.opensearch.index.engine; +/** + * Factory for creating an in InternalEngine instance + * + * @opensearch.internal + */ public class InternalEngineFactory implements EngineFactory { @Override public Engine newReadWriteEngine(EngineConfig config) { diff --git a/server/src/main/java/org/opensearch/index/engine/LiveVersionMap.java b/server/src/main/java/org/opensearch/index/engine/LiveVersionMap.java index 44715637fd791..943792171d2e5 100644 --- a/server/src/main/java/org/opensearch/index/engine/LiveVersionMap.java +++ b/server/src/main/java/org/opensearch/index/engine/LiveVersionMap.java @@ -46,7 +46,11 @@ import java.util.Map; import java.util.concurrent.atomic.AtomicLong; -/** Maps _uid value to its version information. */ +/** + * Maps _uid value to its version information. + * + * @opensearch.internal + */ final class LiveVersionMap implements ReferenceManager.RefreshListener, Accountable { private final KeyedLock keyedLock = new KeyedLock<>(); diff --git a/server/src/main/java/org/opensearch/index/engine/LuceneChangesSnapshot.java b/server/src/main/java/org/opensearch/index/engine/LuceneChangesSnapshot.java index 98da554a5a1b0..6b3a8d76defb5 100644 --- a/server/src/main/java/org/opensearch/index/engine/LuceneChangesSnapshot.java +++ b/server/src/main/java/org/opensearch/index/engine/LuceneChangesSnapshot.java @@ -64,6 +64,8 @@ /** * A {@link Translog.Snapshot} from changes in a Lucene index + * + * @opensearch.internal */ final class LuceneChangesSnapshot implements Translog.Snapshot { static final int DEFAULT_BATCH_SIZE = 1024; diff --git a/server/src/main/java/org/opensearch/index/engine/MissingHistoryOperationsException.java b/server/src/main/java/org/opensearch/index/engine/MissingHistoryOperationsException.java index 7c7a32a57bf9a..b14e488791f02 100644 --- a/server/src/main/java/org/opensearch/index/engine/MissingHistoryOperationsException.java +++ b/server/src/main/java/org/opensearch/index/engine/MissingHistoryOperationsException.java @@ -35,6 +35,8 @@ /** * Exception indicating that not all requested operations from {@link LuceneChangesSnapshot} * are available. + * + * @opensearch.internal */ public final class MissingHistoryOperationsException extends IllegalStateException { diff --git a/server/src/main/java/org/opensearch/index/engine/NoOpEngine.java b/server/src/main/java/org/opensearch/index/engine/NoOpEngine.java index 5db1bb05bbc24..3a16d884fd899 100644 --- a/server/src/main/java/org/opensearch/index/engine/NoOpEngine.java +++ b/server/src/main/java/org/opensearch/index/engine/NoOpEngine.java @@ -61,6 +61,8 @@ * index, get), throw {@link UnsupportedOperationException}. However, NoOpEngine * allows to trim any existing translog files through the usage of the * {{@link #trimUnreferencedTranslogFiles()}} method. + * + * @opensearch.internal */ public final class NoOpEngine extends ReadOnlyEngine { diff --git a/server/src/main/java/org/opensearch/index/engine/OpenSearchConcurrentMergeScheduler.java b/server/src/main/java/org/opensearch/index/engine/OpenSearchConcurrentMergeScheduler.java index 9deab15991f38..83794578ea2bf 100644 --- a/server/src/main/java/org/opensearch/index/engine/OpenSearchConcurrentMergeScheduler.java +++ b/server/src/main/java/org/opensearch/index/engine/OpenSearchConcurrentMergeScheduler.java @@ -59,6 +59,8 @@ /** * An extension to the {@link ConcurrentMergeScheduler} that provides tracking on merge times, total * and current merges. + * + * @opensearch.internal */ class OpenSearchConcurrentMergeScheduler extends ConcurrentMergeScheduler { diff --git a/server/src/main/java/org/opensearch/index/engine/OpenSearchReaderManager.java b/server/src/main/java/org/opensearch/index/engine/OpenSearchReaderManager.java index b83ce8bea567c..06e5ed3539142 100644 --- a/server/src/main/java/org/opensearch/index/engine/OpenSearchReaderManager.java +++ b/server/src/main/java/org/opensearch/index/engine/OpenSearchReaderManager.java @@ -48,6 +48,7 @@ * * @see SearcherManager * + * @opensearch.internal */ @SuppressForbidden(reason = "reference counting is required here") class OpenSearchReaderManager extends ReferenceManager { diff --git a/server/src/main/java/org/opensearch/index/engine/PrunePostingsMergePolicy.java b/server/src/main/java/org/opensearch/index/engine/PrunePostingsMergePolicy.java index 18f2799edc244..5b186b7a3d841 100644 --- a/server/src/main/java/org/opensearch/index/engine/PrunePostingsMergePolicy.java +++ b/server/src/main/java/org/opensearch/index/engine/PrunePostingsMergePolicy.java @@ -59,6 +59,8 @@ * soft deleted documents independent of the retention policy. Note, in order for this merge policy to be effective it needs to be added * before the {@link org.apache.lucene.index.SoftDeletesRetentionMergePolicy} because otherwise only documents that are deleted / removed * anyways will be pruned. + * + * @opensearch.internal */ final class PrunePostingsMergePolicy extends OneMergeWrappingMergePolicy { diff --git a/server/src/main/java/org/opensearch/index/engine/ReadOnlyEngine.java b/server/src/main/java/org/opensearch/index/engine/ReadOnlyEngine.java index a9037de730398..4314c8fbf87af 100644 --- a/server/src/main/java/org/opensearch/index/engine/ReadOnlyEngine.java +++ b/server/src/main/java/org/opensearch/index/engine/ReadOnlyEngine.java @@ -73,6 +73,8 @@ * engine. * * @see #ReadOnlyEngine(EngineConfig, SeqNoStats, TranslogStats, boolean, Function, boolean) + * + * @opensearch.internal */ public class ReadOnlyEngine extends Engine { diff --git a/server/src/main/java/org/opensearch/index/engine/RecoveryEngineException.java b/server/src/main/java/org/opensearch/index/engine/RecoveryEngineException.java index b473523ec2c4e..5894ed051eeed 100644 --- a/server/src/main/java/org/opensearch/index/engine/RecoveryEngineException.java +++ b/server/src/main/java/org/opensearch/index/engine/RecoveryEngineException.java @@ -38,6 +38,9 @@ import java.io.IOException; +/** + * Exception thrown if there is a problem during recovery + */ public class RecoveryEngineException extends EngineException { private final int phase; diff --git a/server/src/main/java/org/opensearch/index/engine/RecoverySourcePruneMergePolicy.java b/server/src/main/java/org/opensearch/index/engine/RecoverySourcePruneMergePolicy.java index 0a885f23629e6..fb907b3acd2a3 100644 --- a/server/src/main/java/org/opensearch/index/engine/RecoverySourcePruneMergePolicy.java +++ b/server/src/main/java/org/opensearch/index/engine/RecoverySourcePruneMergePolicy.java @@ -61,6 +61,11 @@ import java.util.Objects; import java.util.function.Supplier; +/** + * Merge Policy that prunes the recovery source + * + * @opensearch.internal + */ final class RecoverySourcePruneMergePolicy extends OneMergeWrappingMergePolicy { RecoverySourcePruneMergePolicy(String recoverySourceField, Supplier retainSourceQuerySupplier, MergePolicy in) { super(in, toWrap -> new OneMerge(toWrap.segments) { diff --git a/server/src/main/java/org/opensearch/index/engine/RefreshFailedEngineException.java b/server/src/main/java/org/opensearch/index/engine/RefreshFailedEngineException.java index 0f07e0e6199b7..2341466072f73 100644 --- a/server/src/main/java/org/opensearch/index/engine/RefreshFailedEngineException.java +++ b/server/src/main/java/org/opensearch/index/engine/RefreshFailedEngineException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if refresh fails + * + * @opensearch.internal + */ public class RefreshFailedEngineException extends EngineException { public RefreshFailedEngineException(ShardId shardId, Throwable t) { diff --git a/server/src/main/java/org/opensearch/index/engine/SafeCommitInfo.java b/server/src/main/java/org/opensearch/index/engine/SafeCommitInfo.java index 8c76f735035cb..fcf1cb186269c 100644 --- a/server/src/main/java/org/opensearch/index/engine/SafeCommitInfo.java +++ b/server/src/main/java/org/opensearch/index/engine/SafeCommitInfo.java @@ -35,6 +35,8 @@ /** * Information about the safe commit, for making decisions about recoveries. + * + * @opensearch.internal */ public class SafeCommitInfo { diff --git a/server/src/main/java/org/opensearch/index/engine/Segment.java b/server/src/main/java/org/opensearch/index/engine/Segment.java index 4874d0a30196f..a341e73364356 100644 --- a/server/src/main/java/org/opensearch/index/engine/Segment.java +++ b/server/src/main/java/org/opensearch/index/engine/Segment.java @@ -52,6 +52,11 @@ import java.util.Map; import java.util.Objects; +/** + * A segment in the engine + * + * @opensearch.internal + */ public class Segment implements Writeable { private String name; diff --git a/server/src/main/java/org/opensearch/index/engine/SegmentsStats.java b/server/src/main/java/org/opensearch/index/engine/SegmentsStats.java index 880091c192034..af4a1dc6f4d6b 100644 --- a/server/src/main/java/org/opensearch/index/engine/SegmentsStats.java +++ b/server/src/main/java/org/opensearch/index/engine/SegmentsStats.java @@ -44,6 +44,11 @@ import java.io.IOException; +/** + * Tracker for segment stats + * + * @opensearch.internal + */ public class SegmentsStats implements Writeable, ToXContentFragment { private long count; diff --git a/server/src/main/java/org/opensearch/index/engine/SnapshotFailedEngineException.java b/server/src/main/java/org/opensearch/index/engine/SnapshotFailedEngineException.java index 77c05f62c3c26..7340c21dfb321 100644 --- a/server/src/main/java/org/opensearch/index/engine/SnapshotFailedEngineException.java +++ b/server/src/main/java/org/opensearch/index/engine/SnapshotFailedEngineException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if snapshot fails the engine + * + * @opensearch.internal + */ public class SnapshotFailedEngineException extends EngineException { public SnapshotFailedEngineException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/index/engine/SoftDeletesPolicy.java b/server/src/main/java/org/opensearch/index/engine/SoftDeletesPolicy.java index 72f44db2fa138..eef73f1d49a8e 100644 --- a/server/src/main/java/org/opensearch/index/engine/SoftDeletesPolicy.java +++ b/server/src/main/java/org/opensearch/index/engine/SoftDeletesPolicy.java @@ -48,6 +48,8 @@ /** * A policy that controls how many soft-deleted documents should be retained for peer-recovery and querying history changes purpose. + * + * @opensearch.internal */ final class SoftDeletesPolicy { private final LongSupplier globalCheckpointSupplier; diff --git a/server/src/main/java/org/opensearch/index/engine/TranslogLeafReader.java b/server/src/main/java/org/opensearch/index/engine/TranslogLeafReader.java index 09a670237a8a5..224c1dcab08ab 100644 --- a/server/src/main/java/org/opensearch/index/engine/TranslogLeafReader.java +++ b/server/src/main/java/org/opensearch/index/engine/TranslogLeafReader.java @@ -64,6 +64,8 @@ /** * Internal class that mocks a single doc read from the transaction log as a leaf reader. + * + * @opensearch.internal */ public final class TranslogLeafReader extends LeafReader { diff --git a/server/src/main/java/org/opensearch/index/engine/VersionConflictEngineException.java b/server/src/main/java/org/opensearch/index/engine/VersionConflictEngineException.java index c473f3db6dbf7..8b78b41fc3a70 100644 --- a/server/src/main/java/org/opensearch/index/engine/VersionConflictEngineException.java +++ b/server/src/main/java/org/opensearch/index/engine/VersionConflictEngineException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if there is a version conflict + * + * @opensearch.internal + */ public class VersionConflictEngineException extends EngineException { public VersionConflictEngineException(ShardId shardId, Engine.Operation op, long currentVersion, boolean deleted) { diff --git a/server/src/main/java/org/opensearch/index/engine/VersionValue.java b/server/src/main/java/org/opensearch/index/engine/VersionValue.java index 99f9a83a9902c..a463137d13912 100644 --- a/server/src/main/java/org/opensearch/index/engine/VersionValue.java +++ b/server/src/main/java/org/opensearch/index/engine/VersionValue.java @@ -40,6 +40,11 @@ import java.util.Collection; import java.util.Collections; +/** + * Represents the version of a document in the index + * + * @opensearch.internal + */ abstract class VersionValue implements Accountable { private static final long BASE_RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(VersionValue.class); diff --git a/server/src/main/java/org/opensearch/index/fielddata/AbstractBinaryDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/AbstractBinaryDocValues.java index 6ce3277e3b344..b07033ed265b0 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/AbstractBinaryDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/AbstractBinaryDocValues.java @@ -42,6 +42,8 @@ * {@link DocIdSetIterator} APIs. This impl is safe to use for sorting and * aggregations, which only use {@link #advanceExact(int)} and * {@link #binaryValue()}. + * + * @opensearch.internal */ public abstract class AbstractBinaryDocValues extends BinaryDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/AbstractNumericDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/AbstractNumericDocValues.java index 1bb016ef6546d..a2a70e280187a 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/AbstractNumericDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/AbstractNumericDocValues.java @@ -42,6 +42,8 @@ * {@link DocIdSetIterator} APIs. This impl is safe to use for sorting and * aggregations, which only use {@link #advanceExact(int)} and * {@link #longValue()}. + * + * @opensearch.internal */ public abstract class AbstractNumericDocValues extends NumericDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedDocValues.java index ff46b6feed465..b72ba837808a9 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedDocValues.java @@ -42,6 +42,8 @@ * {@link DocIdSetIterator} APIs. This impl is safe to use for sorting and * aggregations, which only use {@link #advanceExact(int)} and * {@link #ordValue()}. + * + * @opensearch.internal */ public abstract class AbstractSortedDocValues extends SortedDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedNumericDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedNumericDocValues.java index f911dc8b990bd..6379533069bc6 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedNumericDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedNumericDocValues.java @@ -42,6 +42,8 @@ * {@link DocIdSetIterator} APIs. This impl is safe to use for sorting and * aggregations, which only use {@link #advanceExact(int)} and * {@link #docValueCount()} and {@link #nextValue()}. + * + * @opensearch.internal */ public abstract class AbstractSortedNumericDocValues extends SortedNumericDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedSetDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedSetDocValues.java index 42a3b440feaef..c7312f2074b9e 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedSetDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortedSetDocValues.java @@ -42,6 +42,8 @@ * {@link DocIdSetIterator} APIs. This impl is safe to use for sorting and * aggregations, which only use {@link #advanceExact(int)} and * {@link #getValueCount()} and {@link #nextOrd()} and {@link #lookupOrd(long)}. + * + * @opensearch.internal */ public abstract class AbstractSortedSetDocValues extends SortedSetDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortingNumericDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortingNumericDocValues.java index 6d93df9f17452..f37dcac740f6a 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/AbstractSortingNumericDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/AbstractSortingNumericDocValues.java @@ -42,6 +42,8 @@ * {@link DocIdSetIterator} APIs. This impl is safe to use for sorting and * aggregations, which only use {@link #advanceExact(int)} and * {@link #docValueCount()} and {@link #nextValue()}. + * + * @opensearch.internal */ public abstract class AbstractSortingNumericDocValues extends SortingNumericDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/DocValueBits.java b/server/src/main/java/org/opensearch/index/fielddata/DocValueBits.java index b94de0d529f96..18fa26bd10623 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/DocValueBits.java +++ b/server/src/main/java/org/opensearch/index/fielddata/DocValueBits.java @@ -34,6 +34,11 @@ import java.io.IOException; +/** + * Base class for doc value bit sets + * + * @opensearch.internal + */ public abstract class DocValueBits { /** diff --git a/server/src/main/java/org/opensearch/index/fielddata/FieldData.java b/server/src/main/java/org/opensearch/index/fielddata/FieldData.java index 93ae689a51f7b..a45cd79f68126 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/FieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/FieldData.java @@ -46,6 +46,8 @@ /** * Utility methods, similar to Lucene's {@link DocValues}. + * + * @opensearch.internal */ public enum FieldData { ; diff --git a/server/src/main/java/org/opensearch/index/fielddata/FieldDataStats.java b/server/src/main/java/org/opensearch/index/fielddata/FieldDataStats.java index fe27fccd1e3c9..8e6cbb3314637 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/FieldDataStats.java +++ b/server/src/main/java/org/opensearch/index/fielddata/FieldDataStats.java @@ -44,6 +44,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Encapsulates heap usage for field data + * + * @opensearch.internal + */ public class FieldDataStats implements Writeable, ToXContentFragment { private static final String FIELDDATA = "fielddata"; diff --git a/server/src/main/java/org/opensearch/index/fielddata/GeoPointValues.java b/server/src/main/java/org/opensearch/index/fielddata/GeoPointValues.java index 98bb9f0f11e74..ce11a015d2d5b 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/GeoPointValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/GeoPointValues.java @@ -38,6 +38,8 @@ /** * Per-document geo-point values. + * + * @opensearch.internal */ public abstract class GeoPointValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/HistogramValue.java b/server/src/main/java/org/opensearch/index/fielddata/HistogramValue.java index 4d3cf4f086429..bb7a89e2e783f 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/HistogramValue.java +++ b/server/src/main/java/org/opensearch/index/fielddata/HistogramValue.java @@ -37,6 +37,8 @@ /** * Per-document histogram value. Every value of the histogram consist on * a value and a count. + * + * @opensearch.internal */ public abstract class HistogramValue { diff --git a/server/src/main/java/org/opensearch/index/fielddata/HistogramValues.java b/server/src/main/java/org/opensearch/index/fielddata/HistogramValues.java index ed5e9b307f693..001d9fdb7b8eb 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/HistogramValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/HistogramValues.java @@ -36,6 +36,8 @@ /** * Per-segment histogram values. + * + * @opensearch.internal */ public abstract class HistogramValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/IndexFieldData.java index deda9081e0448..9b9258efb1cc3 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexFieldData.java @@ -63,6 +63,8 @@ /** * Thread-safe utility class that allows to get per-segment values via the * {@link #load(LeafReaderContext)} method. + * + * @opensearch.internal */ public interface IndexFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataCache.java b/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataCache.java index 5d648038112a8..08aaadcac0d60 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataCache.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataCache.java @@ -39,6 +39,8 @@ /** * A simple field data cache abstraction on the *index* level. + * + * @opensearch.internal */ public interface IndexFieldDataCache { diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataService.java b/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataService.java index 26fcbb7cc9621..46855b9a46833 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataService.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexFieldDataService.java @@ -54,6 +54,11 @@ import java.util.Map; import java.util.function.Supplier; +/** + * Service for field data (cacheing, etc) + * + * @opensearch.internal + */ public class IndexFieldDataService extends AbstractIndexComponent implements Closeable { public static final String FIELDDATA_CACHE_VALUE_NODE = "node"; public static final String FIELDDATA_CACHE_KEY = "index.fielddata.cache"; diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexGeoPointFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/IndexGeoPointFieldData.java index 05a704ec2c785..bcee1cd112ab2 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexGeoPointFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexGeoPointFieldData.java @@ -34,5 +34,7 @@ /** * Specialization of {@link IndexFieldData} for geo points. + * + * @opensearch.internal */ public interface IndexGeoPointFieldData extends IndexFieldData {} diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexHistogramFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/IndexHistogramFieldData.java index a2ad4a14408d6..b9d205665d0c7 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexHistogramFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexHistogramFieldData.java @@ -36,6 +36,8 @@ /** * Specialization of {@link IndexFieldData} for histograms. + * + * @opensearch.internal */ public abstract class IndexHistogramFieldData implements IndexFieldData { protected final String fieldName; diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexNumericFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/IndexNumericFieldData.java index dd987e9f79546..e4beb46b451f2 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexNumericFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexNumericFieldData.java @@ -55,6 +55,8 @@ /** * Base class for numeric field data. + * + * @opensearch.internal */ public abstract class IndexNumericFieldData implements IndexFieldData { /** diff --git a/server/src/main/java/org/opensearch/index/fielddata/IndexOrdinalsFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/IndexOrdinalsFieldData.java index 93f08471bc84a..9831c69744908 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/IndexOrdinalsFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/IndexOrdinalsFieldData.java @@ -38,6 +38,8 @@ /** * Specialization of {@link IndexFieldData} for data that is indexed with ordinals. + * + * @opensearch.internal */ public interface IndexOrdinalsFieldData extends IndexFieldData.Global { diff --git a/server/src/main/java/org/opensearch/index/fielddata/LeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/LeafFieldData.java index 52517326e2b6d..2982363937710 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/LeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/LeafFieldData.java @@ -41,6 +41,8 @@ /** * The thread safe {@link org.apache.lucene.index.LeafReader} level cache of the data. + * + * @opensearch.internal */ public interface LeafFieldData extends Accountable, Releasable { diff --git a/server/src/main/java/org/opensearch/index/fielddata/LeafGeoPointFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/LeafGeoPointFieldData.java index 6048e4559b773..bc3a0cfd22516 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/LeafGeoPointFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/LeafGeoPointFieldData.java @@ -33,6 +33,8 @@ /** * {@link LeafFieldData} specialization for geo points. + * + * @opensearch.internal */ public interface LeafGeoPointFieldData extends LeafFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/LeafHistogramFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/LeafHistogramFieldData.java index 701ff3e553ac4..e968ecc1e0a38 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/LeafHistogramFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/LeafHistogramFieldData.java @@ -35,6 +35,8 @@ /** * {@link LeafFieldData} specialization for histogram data. + * + * @opensearch.internal */ public interface LeafHistogramFieldData extends LeafFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/LeafNumericFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/LeafNumericFieldData.java index 09dd424733ae0..d50da962ecd2a 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/LeafNumericFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/LeafNumericFieldData.java @@ -36,6 +36,8 @@ /** * Specialization of {@link LeafFieldData} for numeric data. + * + * @opensearch.internal */ public interface LeafNumericFieldData extends LeafFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/LeafOrdinalsFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/LeafOrdinalsFieldData.java index 09c45885e8ffe..c9b9cbe2796fc 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/LeafOrdinalsFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/LeafOrdinalsFieldData.java @@ -37,6 +37,8 @@ /** * Specialization of {@link LeafFieldData} for data that is indexed with * ordinals. + * + * @opensearch.internal */ public interface LeafOrdinalsFieldData extends LeafFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/MultiGeoPointValues.java b/server/src/main/java/org/opensearch/index/fielddata/MultiGeoPointValues.java index e6ac006f2b19f..2df4baeb8631b 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/MultiGeoPointValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/MultiGeoPointValues.java @@ -49,6 +49,8 @@ * * The set of values associated with a document might contain duplicates and * comes in a non-specified order. + * + * @opensearch.internal */ public abstract class MultiGeoPointValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/NumericDoubleValues.java b/server/src/main/java/org/opensearch/index/fielddata/NumericDoubleValues.java index ae6fcd514d310..94ea91849ff12 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/NumericDoubleValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/NumericDoubleValues.java @@ -39,6 +39,8 @@ /** * A per-document numeric value. + * + * @opensearch.internal */ public abstract class NumericDoubleValues extends DoubleValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/RamAccountingTermsEnum.java b/server/src/main/java/org/opensearch/index/fielddata/RamAccountingTermsEnum.java index 64fee22ac6302..cd858278afaa3 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/RamAccountingTermsEnum.java +++ b/server/src/main/java/org/opensearch/index/fielddata/RamAccountingTermsEnum.java @@ -43,6 +43,8 @@ * {@link TermsEnum} that takes a CircuitBreaker, increasing the breaker * every time {@code .next(...)} is called. Proxies all methods to the original * TermsEnum otherwise. + * + * @opensearch.internal */ public final class RamAccountingTermsEnum extends FilteredTermsEnum { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ScriptDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/ScriptDocValues.java index 4f0c8d7eb9764..5f2d899b9d1e8 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ScriptDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ScriptDocValues.java @@ -57,6 +57,8 @@ * Implementations should not internally re-use objects for the values that they * return as a single {@link ScriptDocValues} instance can be reused to return * values form multiple documents. + * + * @opensearch.internal */ public abstract class ScriptDocValues extends AbstractList { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ShardFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/ShardFieldData.java index 235ec79f18ff2..f816ff7a436f2 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ShardFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ShardFieldData.java @@ -44,6 +44,11 @@ import java.util.Map; import java.util.concurrent.ConcurrentMap; +/** + * On heap field data for shards + * + * @opensearch.internal + */ public class ShardFieldData implements IndexFieldDataCache.Listener { private final CounterMetric evictionsMetric = new CounterMetric(); diff --git a/server/src/main/java/org/opensearch/index/fielddata/SingletonMultiGeoPointValues.java b/server/src/main/java/org/opensearch/index/fielddata/SingletonMultiGeoPointValues.java index cd0dd3f69f809..56a3a04eee5be 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SingletonMultiGeoPointValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SingletonMultiGeoPointValues.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Multiple geopoint doc value provider + * + * @opensearch.internal + */ final class SingletonMultiGeoPointValues extends MultiGeoPointValues { private final GeoPointValues in; diff --git a/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedBinaryDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedBinaryDocValues.java index ff4cb72719c61..9496e6ec8a69d 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedBinaryDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedBinaryDocValues.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Provider for sorted binary docvalues + * + * @opensearch.internal + */ final class SingletonSortedBinaryDocValues extends SortedBinaryDocValues { private final BinaryDocValues in; diff --git a/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedNumericDoubleValues.java b/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedNumericDoubleValues.java index 2baac237035b3..4ee494ffb30aa 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedNumericDoubleValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SingletonSortedNumericDoubleValues.java @@ -39,6 +39,8 @@ *

    * This can be used if you want to have one multi-valued implementation * that works for single or multi-valued types. + * + * @opensearch.internal */ final class SingletonSortedNumericDoubleValues extends SortedNumericDoubleValues { private final NumericDoubleValues in; diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsNumericDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsNumericDocValues.java index 63600f400b844..39aca38c331ea 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsNumericDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsNumericDocValues.java @@ -41,6 +41,8 @@ * {@link NumericDocValues} instance that wraps a {@link NumericDoubleValues} * and converts the doubles to sortable long bits using * {@link NumericUtils#doubleToSortableLong(double)}. + * + * @opensearch.internal */ final class SortableLongBitsNumericDocValues extends AbstractNumericDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsSortedNumericDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsSortedNumericDocValues.java index 702208fd3db58..ef2fcc6e2fa75 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsSortedNumericDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsSortedNumericDocValues.java @@ -41,6 +41,8 @@ * {@link SortedNumericDocValues} instance that wraps a {@link SortedNumericDoubleValues} * and converts the doubles to sortable long bits using * {@link NumericUtils#doubleToSortableLong(double)}. + * + * @opensearch.internal */ final class SortableLongBitsSortedNumericDocValues extends AbstractSortedNumericDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToNumericDoubleValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToNumericDoubleValues.java index a585b90e86118..150e114d342de 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToNumericDoubleValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToNumericDoubleValues.java @@ -41,6 +41,8 @@ * {@link NumericDoubleValues} instance that wraps a {@link NumericDocValues} * and converts the doubles to sortable long bits using * {@link NumericUtils#sortableLongToDouble(long)}. + * + * @opensearch.internal */ final class SortableLongBitsToNumericDoubleValues extends NumericDoubleValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToSortedNumericDoubleValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToSortedNumericDoubleValues.java index 1538fd089ea21..1bae845c9b0d2 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToSortedNumericDoubleValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortableLongBitsToSortedNumericDoubleValues.java @@ -41,6 +41,8 @@ * {@link SortedNumericDoubleValues} instance that wraps a {@link SortedNumericDocValues} * and converts the doubles to sortable long bits using * {@link NumericUtils#sortableLongToDouble(long)}. + * + * @opensearch.internal */ final class SortableLongBitsToSortedNumericDoubleValues extends SortedNumericDoubleValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortedBinaryDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortedBinaryDocValues.java index f448c24aa7dc7..bd66d1d94f33c 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortedBinaryDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortedBinaryDocValues.java @@ -40,6 +40,8 @@ * A list of per-document binary values, sorted * according to {@link BytesRef#compareTo(BytesRef)}. * There might be dups however. + * + * @opensearch.internal */ // TODO: Should it expose a count (current approach) or return null when there are no more values? public abstract class SortedBinaryDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortedNumericDoubleValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortedNumericDoubleValues.java index 1fe1310e9f693..91d28113ae783 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortedNumericDoubleValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortedNumericDoubleValues.java @@ -38,6 +38,8 @@ /** * Clone of {@link SortedNumericDocValues} for double values. + * + * @opensearch.internal */ public abstract class SortedNumericDoubleValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortingBinaryDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortingBinaryDocValues.java index 33efe556acef9..ba415e7bc0276 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortingBinaryDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortingBinaryDocValues.java @@ -43,6 +43,8 @@ /** * Base class for building {@link SortedBinaryDocValues} instances based on unsorted content. + * + * @opensearch.internal */ public abstract class SortingBinaryDocValues extends SortedBinaryDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDocValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDocValues.java index 12b6eb4e39340..cdfb1e3252899 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDocValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDocValues.java @@ -41,6 +41,8 @@ /** * Base class for building {@link SortedNumericDocValues} instances based on unsorted content. + * + * @opensearch.internal */ public abstract class SortingNumericDocValues extends SortedNumericDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDoubleValues.java b/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDoubleValues.java index 28c72c722dd38..bb125dc600b74 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDoubleValues.java +++ b/server/src/main/java/org/opensearch/index/fielddata/SortingNumericDoubleValues.java @@ -38,6 +38,8 @@ /** * Base class for building {@link SortedNumericDoubleValues} instances based on unsorted content. + * + * @opensearch.internal */ public abstract class SortingNumericDoubleValues extends SortedNumericDoubleValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/BytesRefFieldComparatorSource.java b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/BytesRefFieldComparatorSource.java index d25443914ebaa..51dde57563ec6 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/BytesRefFieldComparatorSource.java +++ b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/BytesRefFieldComparatorSource.java @@ -56,6 +56,8 @@ /** * Comparator source for string/binary values. + * + * @opensearch.internal */ public class BytesRefFieldComparatorSource extends IndexFieldData.XFieldComparatorSource { diff --git a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/DoubleValuesComparatorSource.java b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/DoubleValuesComparatorSource.java index 135101eae362d..f8af86c904f2c 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/DoubleValuesComparatorSource.java +++ b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/DoubleValuesComparatorSource.java @@ -57,6 +57,8 @@ /** * Comparator source for double values. + * + * @opensearch.internal */ public class DoubleValuesComparatorSource extends IndexFieldData.XFieldComparatorSource { diff --git a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/FloatValuesComparatorSource.java b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/FloatValuesComparatorSource.java index f8371e8235070..686bef479c179 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/FloatValuesComparatorSource.java +++ b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/FloatValuesComparatorSource.java @@ -56,6 +56,8 @@ /** * Comparator source for float values. + * + * @opensearch.internal */ public class FloatValuesComparatorSource extends IndexFieldData.XFieldComparatorSource { diff --git a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/LongValuesComparatorSource.java b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/LongValuesComparatorSource.java index 3871425f1255f..462092dca5110 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/LongValuesComparatorSource.java +++ b/server/src/main/java/org/opensearch/index/fielddata/fieldcomparator/LongValuesComparatorSource.java @@ -57,6 +57,8 @@ /** * Comparator source for long values. + * + * @opensearch.internal */ public class LongValuesComparatorSource extends IndexFieldData.XFieldComparatorSource { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalMapping.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalMapping.java index be57ac0771ee5..8fc6eb1a74056 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalMapping.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalMapping.java @@ -42,6 +42,8 @@ /** * A {@link SortedSetDocValues} implementation that returns ordinals that are global. + * + * @opensearch.internal */ final class GlobalOrdinalMapping extends SortedSetDocValues { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsBuilder.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsBuilder.java index 0ed496b5a459f..e136e649d088a 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsBuilder.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsBuilder.java @@ -55,6 +55,8 @@ /** * Utility class to build global ordinals. + * + * @opensearch.internal */ public enum GlobalOrdinalsBuilder { ; diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsIndexFieldData.java index ec554ae78996d..90541b3a9f1c0 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/GlobalOrdinalsIndexFieldData.java @@ -65,6 +65,8 @@ * Each instance of {@link Consumer} uses a new set of {@link TermsEnum} that can be reused during the collection, * this is done to avoid creating all segment's {@link TermsEnum} each time we want to access the values of a single * segment. + * + * @opensearch.internal */ public final class GlobalOrdinalsIndexFieldData implements IndexOrdinalsFieldData, Accountable { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/MultiOrdinals.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/MultiOrdinals.java index 2af4cab7cbdee..e6e51ed83a6ab 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/MultiOrdinals.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/MultiOrdinals.java @@ -51,6 +51,8 @@ /** * {@link Ordinals} implementation which is efficient at storing field data ordinals for multi-valued or sparse fields. + * + * @opensearch.internal */ public class MultiOrdinals extends Ordinals { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/Ordinals.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/Ordinals.java index 52752a828df86..6ce0c06be02ea 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/Ordinals.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/Ordinals.java @@ -38,6 +38,8 @@ /** * A thread safe ordinals abstraction. Ordinals can only be positive integers. + * + * @opensearch.internal */ public abstract class Ordinals implements Accountable { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/OrdinalsBuilder.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/OrdinalsBuilder.java index 5439c884b322f..85a9ba5358c3f 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/OrdinalsBuilder.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/OrdinalsBuilder.java @@ -46,6 +46,8 @@ * Simple class to build document ID <-> ordinal mapping. Note: Ordinals are * {@code 1} based monotonically increasing positive integers. {@code 0} * donates the missing value in this context. + * + * @opensearch.internal */ public final class OrdinalsBuilder implements Closeable { diff --git a/server/src/main/java/org/opensearch/index/fielddata/ordinals/SinglePackedOrdinals.java b/server/src/main/java/org/opensearch/index/fielddata/ordinals/SinglePackedOrdinals.java index a93da9495fbfb..90582079d3f76 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/ordinals/SinglePackedOrdinals.java +++ b/server/src/main/java/org/opensearch/index/fielddata/ordinals/SinglePackedOrdinals.java @@ -45,7 +45,12 @@ import java.util.Collection; import java.util.Collections; -public class SinglePackedOrdinals extends Ordinals { +/** + * Packed ordinals for a single field + * + * @opensearch.internal + */ +class SinglePackedOrdinals extends Ordinals { // ordinals with value 0 indicates no value private final PackedInts.Reader reader; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractBinaryDVLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractBinaryDVLeafFieldData.java index 787401386c120..4d2cb7e84df6c 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractBinaryDVLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractBinaryDVLeafFieldData.java @@ -43,6 +43,11 @@ import java.util.Collection; import java.util.Collections; +/** + * Base class for binary docvalue "field data" + * + * @opensearch.internal + */ abstract class AbstractBinaryDVLeafFieldData implements LeafFieldData { private final BinaryDocValues values; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractIndexOrdinalsFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractIndexOrdinalsFieldData.java index 2102234fdbcc5..7dab513372235 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractIndexOrdinalsFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractIndexOrdinalsFieldData.java @@ -54,6 +54,11 @@ import java.io.IOException; import java.util.function.Function; +/** + * Base class for sorting ordinals field data + * + * @opensearch.internal + */ public abstract class AbstractIndexOrdinalsFieldData implements IndexOrdinalsFieldData { private static final Logger logger = LogManager.getLogger(AbstractBinaryDVLeafFieldData.class); diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLatLonPointIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLatLonPointIndexFieldData.java index 5fefc2fdcef3f..d094acf4ca79d 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLatLonPointIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLatLonPointIndexFieldData.java @@ -51,6 +51,11 @@ import org.opensearch.search.sort.BucketedSort; import org.opensearch.search.sort.SortOrder; +/** + * Base class for sorting LatLonPoint docvalues + * + * @opensearch.internal + */ public abstract class AbstractLatLonPointIndexFieldData implements IndexGeoPointFieldData { protected final String fieldName; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafGeoPointFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafGeoPointFieldData.java index f614d8aaef51a..89c462267a4d2 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafGeoPointFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafGeoPointFieldData.java @@ -41,6 +41,11 @@ import java.util.Collection; import java.util.Collections; +/** + * Base class for retrieving LatLonPoint docvalues + * + * @opensearch.internal + */ public abstract class AbstractLeafGeoPointFieldData implements LeafGeoPointFieldData { @Override diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafOrdinalsFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafOrdinalsFieldData.java index 736b1f5e61ce7..0e16dbbd06271 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafOrdinalsFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/AbstractLeafOrdinalsFieldData.java @@ -44,6 +44,11 @@ import java.util.Collections; import java.util.function.Function; +/** + * Baseclass for ordinals docvalues + * + * @opensearch.internal + */ public abstract class AbstractLeafOrdinalsFieldData implements LeafOrdinalsFieldData { public static final Function> DEFAULT_SCRIPT_FUNCTION = ((Function< diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryDVLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryDVLeafFieldData.java index 24936c8f3d665..dd8235977af8f 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryDVLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryDVLeafFieldData.java @@ -46,7 +46,11 @@ import java.util.Collection; import java.util.Collections; -/** {@link LeafFieldData} impl on top of Lucene's binary doc values. */ +/** + * {@link LeafFieldData} impl on top of Lucene's binary doc values. + * + * @opensearch.internal + */ public class BinaryDVLeafFieldData implements LeafFieldData { private final LeafReader reader; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryIndexFieldData.java index 3038b9b10ef83..6d3c1b8c14430 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/BinaryIndexFieldData.java @@ -47,6 +47,11 @@ import org.opensearch.search.sort.BucketedSort; import org.opensearch.search.sort.SortOrder; +/** + * Binary doc values ValuesSource + * + * @opensearch.internal + */ public class BinaryIndexFieldData implements IndexFieldData { public static class Builder implements IndexFieldData.Builder { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryDVLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryDVLeafFieldData.java index 7df4a415917e2..247658cabb8da 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryDVLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryDVLeafFieldData.java @@ -36,6 +36,11 @@ import org.apache.lucene.util.BytesRef; import org.opensearch.index.fielddata.ScriptDocValues; +/** + * Binary valuessource for scripting + * + * @opensearch.internal + */ final class BytesBinaryDVLeafFieldData extends AbstractBinaryDVLeafFieldData { BytesBinaryDVLeafFieldData(BinaryDocValues values) { super(values); diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryIndexFieldData.java index 029beaf587a27..dbcbb26c5287e 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/BytesBinaryIndexFieldData.java @@ -49,6 +49,11 @@ import java.io.IOException; +/** + * Binary docvalue values source + * + * @opensearch.internal + */ public class BytesBinaryIndexFieldData implements IndexFieldData { protected final String fieldName; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/ConstantIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/ConstantIndexFieldData.java index 763d6b27f74ee..1092b5ecb847f 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/ConstantIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/ConstantIndexFieldData.java @@ -59,6 +59,11 @@ import java.util.Collection; import java.util.Collections; +/** + * Constant value field data + * + * @opensearch.internal + */ public class ConstantIndexFieldData extends AbstractIndexOrdinalsFieldData { public static class Builder implements IndexFieldData.Builder { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/LatLonPointDVLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/LatLonPointDVLeafFieldData.java index 6b7e182a98af9..814dc1cdd237b 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/LatLonPointDVLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/LatLonPointDVLeafFieldData.java @@ -43,6 +43,11 @@ import java.util.Collection; import java.util.Collections; +/** + * LatLonPoint field data + * + * @opensearch.internal + */ final class LatLonPointDVLeafFieldData extends AbstractLeafGeoPointFieldData { private final LeafReader reader; private final String fieldName; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/LeafDoubleFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/LeafDoubleFieldData.java index e74f6f44752a5..47dc02ef093de 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/LeafDoubleFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/LeafDoubleFieldData.java @@ -48,6 +48,8 @@ /** * Specialization of {@link LeafNumericFieldData} for floating-point numerics. + * + * @opensearch.internal */ public abstract class LeafDoubleFieldData implements LeafNumericFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/LeafLongFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/LeafLongFieldData.java index 94e44853f74ae..408021dd5f096 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/LeafLongFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/LeafLongFieldData.java @@ -46,6 +46,8 @@ /** * Specialization of {@link LeafNumericFieldData} for integers. + * + * @opensearch.internal */ public abstract class LeafLongFieldData implements LeafNumericFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesIndexFieldData.java index e661b61548cd0..4b6cb287a078f 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesIndexFieldData.java @@ -64,6 +64,11 @@ import java.io.IOException; +/** + * Doc Values for paged bytes + * + * @opensearch.internal + */ public class PagedBytesIndexFieldData extends AbstractIndexOrdinalsFieldData { private final double minFrequency, maxFrequency; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesLeafFieldData.java index bbd8ef4645718..b54dccfb82f8f 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/PagedBytesLeafFieldData.java @@ -44,6 +44,11 @@ import java.util.Collections; import java.util.List; +/** + * Field Data for Paged Bytes + * + * @opensearch.internal + */ public class PagedBytesLeafFieldData extends AbstractLeafOrdinalsFieldData { private final PagedBytes.Reader bytes; diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/SortedNumericIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/SortedNumericIndexFieldData.java index 714b762f81fb7..65a3b8563a4ce 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/SortedNumericIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/SortedNumericIndexFieldData.java @@ -65,6 +65,8 @@ /** * FieldData backed by {@link LeafReader#getSortedNumericDocValues(String)} * @see DocValuesType#SORTED_NUMERIC + * + * @opensearch.internal */ public class SortedNumericIndexFieldData extends IndexNumericFieldData { public static class Builder implements IndexFieldData.Builder { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetBytesLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetBytesLeafFieldData.java index bb7d44938c03d..89502a6358881 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetBytesLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetBytesLeafFieldData.java @@ -46,6 +46,8 @@ /** * An {@link LeafFieldData} implementation that uses Lucene {@link SortedSetDocValues}. + * + * @opensearch.internal */ public final class SortedSetBytesLeafFieldData extends AbstractLeafOrdinalsFieldData { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetOrdinalsIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetOrdinalsIndexFieldData.java index ef69cb69e84c9..682b3de27a04a 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetOrdinalsIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/SortedSetOrdinalsIndexFieldData.java @@ -55,6 +55,11 @@ import java.util.function.Function; +/** + * Sorted Set Ordinals doc values + * + * @opensearch.internal + */ public class SortedSetOrdinalsIndexFieldData extends AbstractIndexOrdinalsFieldData { public static class Builder implements IndexFieldData.Builder { diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryDVLeafFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryDVLeafFieldData.java index 137f1ad22ea9f..1c0f13ff13f23 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryDVLeafFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryDVLeafFieldData.java @@ -35,6 +35,11 @@ import org.apache.lucene.index.BinaryDocValues; import org.opensearch.index.fielddata.ScriptDocValues; +/** + * Field data for binary strings + * + * @opensearch.internal + */ final class StringBinaryDVLeafFieldData extends AbstractBinaryDVLeafFieldData { StringBinaryDVLeafFieldData(BinaryDocValues values) { super(values); diff --git a/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryIndexFieldData.java b/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryIndexFieldData.java index 72c39acec4e90..9e0c494d9432d 100644 --- a/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryIndexFieldData.java +++ b/server/src/main/java/org/opensearch/index/fielddata/plain/StringBinaryIndexFieldData.java @@ -47,6 +47,11 @@ import java.io.IOException; +/** + * Field Data for binary strings + * + * @opensearch.internal + */ public class StringBinaryIndexFieldData implements IndexFieldData { protected final String fieldName; diff --git a/server/src/main/java/org/opensearch/index/fieldvisitor/CustomFieldsVisitor.java b/server/src/main/java/org/opensearch/index/fieldvisitor/CustomFieldsVisitor.java index 5be2fa5209ca5..df4d398b2b181 100644 --- a/server/src/main/java/org/opensearch/index/fieldvisitor/CustomFieldsVisitor.java +++ b/server/src/main/java/org/opensearch/index/fieldvisitor/CustomFieldsVisitor.java @@ -40,6 +40,8 @@ * Supported pattern styles: "xxx*", "*xxx", "*xxx*" and "xxx*yyy". * The Uid field is always loaded. * The class is optimized for source loading as it is a common use case. + * + * @opensearch.internal */ public class CustomFieldsVisitor extends FieldsVisitor { diff --git a/server/src/main/java/org/opensearch/index/fieldvisitor/FieldsVisitor.java b/server/src/main/java/org/opensearch/index/fieldvisitor/FieldsVisitor.java index eb094ce1df9a4..d1c0e48570576 100644 --- a/server/src/main/java/org/opensearch/index/fieldvisitor/FieldsVisitor.java +++ b/server/src/main/java/org/opensearch/index/fieldvisitor/FieldsVisitor.java @@ -57,6 +57,8 @@ /** * Base {@link StoredFieldVisitor} that retrieves all non-redundant metadata. + * + * @opensearch.internal */ public class FieldsVisitor extends StoredFieldVisitor { private static final Set BASE_REQUIRED_FIELDS = unmodifiableSet(newHashSet(IdFieldMapper.NAME, RoutingFieldMapper.NAME)); diff --git a/server/src/main/java/org/opensearch/index/fieldvisitor/IdOnlyFieldVisitor.java b/server/src/main/java/org/opensearch/index/fieldvisitor/IdOnlyFieldVisitor.java index 67ec285f50cbf..b56026e0ffe49 100644 --- a/server/src/main/java/org/opensearch/index/fieldvisitor/IdOnlyFieldVisitor.java +++ b/server/src/main/java/org/opensearch/index/fieldvisitor/IdOnlyFieldVisitor.java @@ -37,6 +37,11 @@ import org.opensearch.index.mapper.IdFieldMapper; import org.opensearch.index.mapper.Uid; +/** + * Visitor pattern for doc ids only + * + * @opensearch.internal + */ public final class IdOnlyFieldVisitor extends StoredFieldVisitor { private String id = null; private boolean visited = false; diff --git a/server/src/main/java/org/opensearch/index/fieldvisitor/SingleFieldsVisitor.java b/server/src/main/java/org/opensearch/index/fieldvisitor/SingleFieldsVisitor.java index 3214ec2780701..69cef51c24421 100644 --- a/server/src/main/java/org/opensearch/index/fieldvisitor/SingleFieldsVisitor.java +++ b/server/src/main/java/org/opensearch/index/fieldvisitor/SingleFieldsVisitor.java @@ -42,6 +42,8 @@ /** * {@linkplain StoredFieldVisitor} that loads a single field value. + * + * @opensearch.internal */ public final class SingleFieldsVisitor extends StoredFieldVisitor { private final MappedFieldType field; diff --git a/server/src/main/java/org/opensearch/index/flush/FlushStats.java b/server/src/main/java/org/opensearch/index/flush/FlushStats.java index cfe28edf4c988..2490f22416c83 100644 --- a/server/src/main/java/org/opensearch/index/flush/FlushStats.java +++ b/server/src/main/java/org/opensearch/index/flush/FlushStats.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Encapsulates statistics for flush + * + * @opensearch.internal + */ public class FlushStats implements Writeable, ToXContentFragment { private long total; diff --git a/server/src/main/java/org/opensearch/index/get/GetResult.java b/server/src/main/java/org/opensearch/index/get/GetResult.java index aa2bf43c5b290..e2f23353f250e 100644 --- a/server/src/main/java/org/opensearch/index/get/GetResult.java +++ b/server/src/main/java/org/opensearch/index/get/GetResult.java @@ -63,6 +63,11 @@ import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_PRIMARY_TERM; import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_SEQ_NO; +/** + * Result provided for a search get + * + * @opensearch.api + */ public class GetResult implements Writeable, Iterable, ToXContentObject { public static final String _INDEX = "_index"; diff --git a/server/src/main/java/org/opensearch/index/get/GetStats.java b/server/src/main/java/org/opensearch/index/get/GetStats.java index fb37b5dfc6b42..06dc19e6349c1 100644 --- a/server/src/main/java/org/opensearch/index/get/GetStats.java +++ b/server/src/main/java/org/opensearch/index/get/GetStats.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Stats for a search get + * + * @opensearch.api + */ public class GetStats implements Writeable, ToXContentFragment { private long existsCount; diff --git a/server/src/main/java/org/opensearch/index/get/ShardGetService.java b/server/src/main/java/org/opensearch/index/get/ShardGetService.java index 6aa10bc450b51..7b34ab5f0d5da 100644 --- a/server/src/main/java/org/opensearch/index/get/ShardGetService.java +++ b/server/src/main/java/org/opensearch/index/get/ShardGetService.java @@ -84,6 +84,11 @@ import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_PRIMARY_TERM; import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_SEQ_NO; +/** + * Gets an index shard + * + * @opensearch.internal + */ public final class ShardGetService extends AbstractIndexShardComponent { private final MapperService mapperService; private final MeanMetric existsMetric = new MeanMetric(); diff --git a/server/src/main/java/org/opensearch/index/mapper/AbstractGeometryFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/AbstractGeometryFieldMapper.java index 0d90e694ef481..dd7a1fd3e027a 100644 --- a/server/src/main/java/org/opensearch/index/mapper/AbstractGeometryFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/AbstractGeometryFieldMapper.java @@ -62,6 +62,8 @@ /** * Base field mapper class for all spatial field types + * + * @opensearch.internal */ public abstract class AbstractGeometryFieldMapper extends FieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/AbstractPointGeometryFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/AbstractPointGeometryFieldMapper.java index 19e3a5073fd8c..a5e8f4d1d10e4 100644 --- a/server/src/main/java/org/opensearch/index/mapper/AbstractPointGeometryFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/AbstractPointGeometryFieldMapper.java @@ -56,7 +56,11 @@ import static org.opensearch.index.mapper.TypeParsers.parseField; -/** Base class for for spatial fields that only support indexing points */ +/** + * Base class for for spatial fields that only support indexing points + * + * @opensearch.internal + */ public abstract class AbstractPointGeometryFieldMapper extends AbstractGeometryFieldMapper { public static class Names extends AbstractGeometryFieldMapper.Names { diff --git a/server/src/main/java/org/opensearch/index/mapper/AbstractShapeGeometryFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/AbstractShapeGeometryFieldMapper.java index 56ef58f1b92e9..4586360f8ce82 100644 --- a/server/src/main/java/org/opensearch/index/mapper/AbstractShapeGeometryFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/AbstractShapeGeometryFieldMapper.java @@ -48,6 +48,8 @@ /** * Base class for {@link GeoShapeFieldMapper} and {@link LegacyGeoShapeFieldMapper} + * + * @opensearch.internal */ public abstract class AbstractShapeGeometryFieldMapper extends AbstractGeometryFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/ArraySourceValueFetcher.java b/server/src/main/java/org/opensearch/index/mapper/ArraySourceValueFetcher.java index f28e4a64eec6e..936d6b4fb7f8b 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ArraySourceValueFetcher.java +++ b/server/src/main/java/org/opensearch/index/mapper/ArraySourceValueFetcher.java @@ -47,6 +47,8 @@ * This class differs from {@link SourceValueFetcher} in that it directly handles * array values in parsing. Field types should use this class if their corresponding * mapper returns true for {@link FieldMapper#parsesArrayValue()}. + * + * @opensearch.internal */ public abstract class ArraySourceValueFetcher implements ValueFetcher { private final Set sourcePaths; diff --git a/server/src/main/java/org/opensearch/index/mapper/BinaryFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/BinaryFieldMapper.java index 68b0df63f2bef..ccc532d0539be 100644 --- a/server/src/main/java/org/opensearch/index/mapper/BinaryFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/BinaryFieldMapper.java @@ -59,6 +59,11 @@ import java.util.Map; import java.util.function.Supplier; +/** + * A mapper for binary fields + * + * @opensearch.internal + */ public class BinaryFieldMapper extends ParametrizedFieldMapper { public static final String CONTENT_TYPE = "binary"; diff --git a/server/src/main/java/org/opensearch/index/mapper/BinaryRangeUtil.java b/server/src/main/java/org/opensearch/index/mapper/BinaryRangeUtil.java index 96744ba2d01d8..f24d3a5853a88 100644 --- a/server/src/main/java/org/opensearch/index/mapper/BinaryRangeUtil.java +++ b/server/src/main/java/org/opensearch/index/mapper/BinaryRangeUtil.java @@ -47,6 +47,11 @@ import java.util.List; import java.util.Set; +/** + * Utility class for binary ranges + * + * @opensearch.internal + */ final class BinaryRangeUtil { private BinaryRangeUtil() {}; diff --git a/server/src/main/java/org/opensearch/index/mapper/BooleanFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/BooleanFieldMapper.java index a14364640d6ee..5d22a0f097298 100644 --- a/server/src/main/java/org/opensearch/index/mapper/BooleanFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/BooleanFieldMapper.java @@ -61,6 +61,8 @@ /** * A field mapper for boolean fields. + * + * @opensearch.internal */ public class BooleanFieldMapper extends ParametrizedFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/CompletionFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/CompletionFieldMapper.java index 2d0f59fc76ea4..73b2603f16221 100644 --- a/server/src/main/java/org/opensearch/index/mapper/CompletionFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/CompletionFieldMapper.java @@ -90,6 +90,8 @@ * against the weighted FST index by the {@link CompletionSuggester}. * This field can also be extended to add search criteria to suggestions * for query-time filtering and boosting (see {@link ContextMappings} + * + * @opensearch.internal */ public class CompletionFieldMapper extends ParametrizedFieldMapper { public static final String CONTENT_TYPE = "completion"; diff --git a/server/src/main/java/org/opensearch/index/mapper/ConstantFieldType.java b/server/src/main/java/org/opensearch/index/mapper/ConstantFieldType.java index 4dec612ceff75..a28a6369b1aa4 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ConstantFieldType.java +++ b/server/src/main/java/org/opensearch/index/mapper/ConstantFieldType.java @@ -51,6 +51,8 @@ * cheap. In particular they should not read data from disk or perform a * network call. Furthermore they may only return a {@link MatchAllDocsQuery} * or a {@link MatchNoDocsQuery}. + * + * @opensearch.internal */ public abstract class ConstantFieldType extends MappedFieldType { diff --git a/server/src/main/java/org/opensearch/index/mapper/ContentPath.java b/server/src/main/java/org/opensearch/index/mapper/ContentPath.java index 951a0bc0f9890..468551aeed287 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ContentPath.java +++ b/server/src/main/java/org/opensearch/index/mapper/ContentPath.java @@ -32,6 +32,11 @@ package org.opensearch.index.mapper; +/** + * JSON Path for a document / field + * + * @opensearch.internal + */ public final class ContentPath { private static final char DELIMITER = '.'; diff --git a/server/src/main/java/org/opensearch/index/mapper/CustomDocValuesField.java b/server/src/main/java/org/opensearch/index/mapper/CustomDocValuesField.java index 664ee45c091bb..2776e7515bbf6 100644 --- a/server/src/main/java/org/opensearch/index/mapper/CustomDocValuesField.java +++ b/server/src/main/java/org/opensearch/index/mapper/CustomDocValuesField.java @@ -41,7 +41,13 @@ import java.io.Reader; -// used for binary, geo and range fields +/** + * Base class for constructing a custom docvalues type + * + * used for binary, geo, and range fields + * + * @opensearch.api + */ public abstract class CustomDocValuesField implements IndexableField { public static final FieldType TYPE = new FieldType(); diff --git a/server/src/main/java/org/opensearch/index/mapper/DataStreamFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/DataStreamFieldMapper.java index 03e792c4893d4..a94d85916338a 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DataStreamFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/DataStreamFieldMapper.java @@ -22,6 +22,11 @@ import java.util.List; import java.util.Map; +/** + * Field mapper for a datastream field + * + * @opensearch.internal + */ public class DataStreamFieldMapper extends MetadataFieldMapper { public static final String NAME = "_data_stream_timestamp"; diff --git a/server/src/main/java/org/opensearch/index/mapper/DateFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/DateFieldMapper.java index e2239069603e6..0aef814f3dedb 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DateFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/DateFieldMapper.java @@ -81,7 +81,11 @@ import static org.opensearch.common.time.DateUtils.toLong; -/** A {@link FieldMapper} for dates. */ +/** + * A {@link FieldMapper} for dates. + * + * @opensearch.internal + */ public final class DateFieldMapper extends ParametrizedFieldMapper { private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(DateFieldMapper.class); diff --git a/server/src/main/java/org/opensearch/index/mapper/DocValueFetcher.java b/server/src/main/java/org/opensearch/index/mapper/DocValueFetcher.java index e97a4cd636197..dd15f72bbd45e 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DocValueFetcher.java +++ b/server/src/main/java/org/opensearch/index/mapper/DocValueFetcher.java @@ -45,6 +45,8 @@ /** * Value fetcher that loads from doc values. + * + * @opensearch.internal */ public final class DocValueFetcher implements ValueFetcher { private final DocValueFormat format; diff --git a/server/src/main/java/org/opensearch/index/mapper/DocumentMapper.java b/server/src/main/java/org/opensearch/index/mapper/DocumentMapper.java index 0bebfa024e185..6c3851315fc60 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DocumentMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/DocumentMapper.java @@ -63,6 +63,11 @@ import java.util.Objects; import java.util.stream.Stream; +/** + * The OpenSearch DocumentMapper + * + * @opensearch.internal + */ public class DocumentMapper implements ToXContentFragment { public static class Builder { diff --git a/server/src/main/java/org/opensearch/index/mapper/DocumentMapperForType.java b/server/src/main/java/org/opensearch/index/mapper/DocumentMapperForType.java index dd92cdfacef64..b26c3f3645433 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DocumentMapperForType.java +++ b/server/src/main/java/org/opensearch/index/mapper/DocumentMapperForType.java @@ -32,6 +32,14 @@ package org.opensearch.index.mapper; +/** + * Document mapper used for types + * + * @opensearch.internal + * + * @deprecated types are being removed + */ +@Deprecated public class DocumentMapperForType { private final DocumentMapper documentMapper; private final Mapping mapping; diff --git a/server/src/main/java/org/opensearch/index/mapper/DocumentMapperParser.java b/server/src/main/java/org/opensearch/index/mapper/DocumentMapperParser.java index 2d6880c6b4186..9fa088396a38b 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DocumentMapperParser.java +++ b/server/src/main/java/org/opensearch/index/mapper/DocumentMapperParser.java @@ -55,6 +55,11 @@ import static java.util.Collections.unmodifiableMap; +/** + * Parser for a document mapper + * + * @opensearch.internal + */ public class DocumentMapperParser { final MapperService mapperService; diff --git a/server/src/main/java/org/opensearch/index/mapper/DocumentParser.java b/server/src/main/java/org/opensearch/index/mapper/DocumentParser.java index df8eb8f38cfcb..a346d57924199 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DocumentParser.java +++ b/server/src/main/java/org/opensearch/index/mapper/DocumentParser.java @@ -56,7 +56,11 @@ import static org.opensearch.index.mapper.FieldMapper.IGNORE_MALFORMED_SETTING; -/** A parser for documents, given mappings from a DocumentMapper */ +/** + * A parser for documents, given mappings from a DocumentMapper + * + * @opensearch.internal + */ final class DocumentParser { private final IndexSettings indexSettings; diff --git a/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldMapper.java index c1ff7fac39111..71f4c312a8c58 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldMapper.java @@ -51,6 +51,8 @@ * * Note: we anticipate that 'flattened' fields will be the only implementation of this * interface. Flattened object fields live in the 'mapper-flattened' module. + * + * @opensearch.internal */ public abstract class DynamicKeyFieldMapper extends FieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldTypeLookup.java b/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldTypeLookup.java index fed914d420eb9..13150ddc50a51 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldTypeLookup.java +++ b/server/src/main/java/org/opensearch/index/mapper/DynamicKeyFieldTypeLookup.java @@ -44,6 +44,8 @@ * * Note: we anticipate that 'flattened' fields will be the only implementation {@link DynamicKeyFieldMapper}. * Flattened object fields live in the 'mapper-flattened' module. + * + * @opensearch.internal */ class DynamicKeyFieldTypeLookup { private final Map mappers; diff --git a/server/src/main/java/org/opensearch/index/mapper/DynamicTemplate.java b/server/src/main/java/org/opensearch/index/mapper/DynamicTemplate.java index e3afb80344686..8a418a7272b0a 100644 --- a/server/src/main/java/org/opensearch/index/mapper/DynamicTemplate.java +++ b/server/src/main/java/org/opensearch/index/mapper/DynamicTemplate.java @@ -44,6 +44,11 @@ import java.util.Map; import java.util.TreeMap; +/** + * A template that is dynamic based on field types + * + * @opensearch.internal + */ public class DynamicTemplate implements ToXContentObject { public enum MatchType { diff --git a/server/src/main/java/org/opensearch/index/mapper/FieldAliasMapper.java b/server/src/main/java/org/opensearch/index/mapper/FieldAliasMapper.java index d716ec1e828f9..30f7de09e6304 100644 --- a/server/src/main/java/org/opensearch/index/mapper/FieldAliasMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/FieldAliasMapper.java @@ -46,6 +46,8 @@ * * A field alias has no concrete field mappings of its own, but instead points to another field by * its path. Once defined, an alias can be used in place of the concrete field name in search requests. + * + * @opensearch.internal */ public final class FieldAliasMapper extends Mapper { public static final String CONTENT_TYPE = "alias"; diff --git a/server/src/main/java/org/opensearch/index/mapper/FieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/FieldMapper.java index 9c383d4b5a653..bd5a671887ef2 100644 --- a/server/src/main/java/org/opensearch/index/mapper/FieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/FieldMapper.java @@ -60,6 +60,11 @@ import java.util.TreeMap; import java.util.stream.StreamSupport; +/** + * The base OpenSearch Field Mapper + * + * @opensearch.internal + */ public abstract class FieldMapper extends Mapper implements Cloneable { public static final Setting IGNORE_MALFORMED_SETTING = Setting.boolSetting( "index.mapping.ignore_malformed", diff --git a/server/src/main/java/org/opensearch/index/mapper/FieldNamesFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/FieldNamesFieldMapper.java index 500df197f4f04..24793e916047b 100644 --- a/server/src/main/java/org/opensearch/index/mapper/FieldNamesFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/FieldNamesFieldMapper.java @@ -48,6 +48,8 @@ /** * A mapper that indexes the field names of a document under _field_names. This mapper is typically useful in order * to have fast exists and missing queries/filters. + * + * @opensearch.internal */ public class FieldNamesFieldMapper extends MetadataFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/FieldTypeLookup.java b/server/src/main/java/org/opensearch/index/mapper/FieldTypeLookup.java index fd1f2df1131ab..bede143ed5e92 100644 --- a/server/src/main/java/org/opensearch/index/mapper/FieldTypeLookup.java +++ b/server/src/main/java/org/opensearch/index/mapper/FieldTypeLookup.java @@ -45,6 +45,8 @@ /** * An immutable container for looking up {@link MappedFieldType}s by their name. + * + * @opensearch.internal */ class FieldTypeLookup implements Iterable { diff --git a/server/src/main/java/org/opensearch/index/mapper/GeoPointFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/GeoPointFieldMapper.java index 123af3a1fe761..3dfdfdb87f8b9 100644 --- a/server/src/main/java/org/opensearch/index/mapper/GeoPointFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/GeoPointFieldMapper.java @@ -65,6 +65,8 @@ * Field Mapper for geo_point types. * * Uses lucene 6 LatLonPoint encoding + * + * @opensearch.internal */ public class GeoPointFieldMapper extends AbstractPointGeometryFieldMapper, List> { public static final String CONTENT_TYPE = "geo_point"; diff --git a/server/src/main/java/org/opensearch/index/mapper/GeoShapeFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/GeoShapeFieldMapper.java index e14f26404eb11..aeda2a2d93f12 100644 --- a/server/src/main/java/org/opensearch/index/mapper/GeoShapeFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/GeoShapeFieldMapper.java @@ -65,6 +65,8 @@ * or: *

    * "field" : "POLYGON ((100.0 0.0, 101.0 0.0, 101.0 1.0, 100.0 1.0, 100.0 0.0)) + * + * @opensearch.internal */ public class GeoShapeFieldMapper extends AbstractShapeGeometryFieldMapper { public static final String CONTENT_TYPE = "geo_shape"; diff --git a/server/src/main/java/org/opensearch/index/mapper/GeoShapeIndexer.java b/server/src/main/java/org/opensearch/index/mapper/GeoShapeIndexer.java index 24e458df3a626..8a1712c0f9645 100644 --- a/server/src/main/java/org/opensearch/index/mapper/GeoShapeIndexer.java +++ b/server/src/main/java/org/opensearch/index/mapper/GeoShapeIndexer.java @@ -60,6 +60,8 @@ /** * Utility class that converts geometries into Lucene-compatible form for indexing in a geo_shape field. + * + * @opensearch.internal */ public class GeoShapeIndexer implements AbstractGeometryFieldMapper.Indexer { diff --git a/server/src/main/java/org/opensearch/index/mapper/GeoShapeParser.java b/server/src/main/java/org/opensearch/index/mapper/GeoShapeParser.java index 1ba1d9ee3be59..d8740b7866773 100644 --- a/server/src/main/java/org/opensearch/index/mapper/GeoShapeParser.java +++ b/server/src/main/java/org/opensearch/index/mapper/GeoShapeParser.java @@ -46,6 +46,11 @@ import java.text.ParseException; import java.util.Collections; +/** + * Utility class that parses geo shapes + * + * @opensearch.internal + */ public class GeoShapeParser extends AbstractGeometryFieldMapper.Parser { private final GeometryParser geometryParser; diff --git a/server/src/main/java/org/opensearch/index/mapper/GeoShapeQueryable.java b/server/src/main/java/org/opensearch/index/mapper/GeoShapeQueryable.java index 7fc6f3cd7c6c6..fbcba13b3676d 100644 --- a/server/src/main/java/org/opensearch/index/mapper/GeoShapeQueryable.java +++ b/server/src/main/java/org/opensearch/index/mapper/GeoShapeQueryable.java @@ -41,6 +41,8 @@ /** * Implemented by {@link org.opensearch.index.mapper.MappedFieldType} that support * GeoShape queries. + * + * @opensearch.internal */ public interface GeoShapeQueryable { diff --git a/server/src/main/java/org/opensearch/index/mapper/IdFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/IdFieldMapper.java index 7ca7b9e81be96..a3c4153ec5373 100644 --- a/server/src/main/java/org/opensearch/index/mapper/IdFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/IdFieldMapper.java @@ -73,6 +73,8 @@ * A mapper for the _id field. It does nothing since _id is neither indexed nor * stored, but we need to keep it so that its FieldType can be used to generate * queries. + * + * @opensearch.internal */ public class IdFieldMapper extends MetadataFieldMapper { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(IdFieldMapper.class); diff --git a/server/src/main/java/org/opensearch/index/mapper/IgnoredFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/IgnoredFieldMapper.java index 0d82b20cfaea6..69e0c414bbcde 100644 --- a/server/src/main/java/org/opensearch/index/mapper/IgnoredFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/IgnoredFieldMapper.java @@ -44,6 +44,8 @@ /** * A field mapper that records fields that have been ignored because they were malformed. + * + * @opensearch.internal */ public final class IgnoredFieldMapper extends MetadataFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/IndexFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/IndexFieldMapper.java index ae32aa52162fe..22feeed3fe675 100644 --- a/server/src/main/java/org/opensearch/index/mapper/IndexFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/IndexFieldMapper.java @@ -44,6 +44,11 @@ import java.util.Collections; import java.util.function.Supplier; +/** + * Index specific field mapper + * + * @opensearch.internal + */ public class IndexFieldMapper extends MetadataFieldMapper { public static final String NAME = "_index"; diff --git a/server/src/main/java/org/opensearch/index/mapper/IpFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/IpFieldMapper.java index 3ba5e1e0dfe35..aa5a5638776cf 100644 --- a/server/src/main/java/org/opensearch/index/mapper/IpFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/IpFieldMapper.java @@ -63,7 +63,11 @@ import java.util.function.BiFunction; import java.util.function.Supplier; -/** A {@link FieldMapper} for ip addresses. */ +/** + * A {@link FieldMapper} for ip addresses. + * + * @opensearch.internal + */ public class IpFieldMapper extends ParametrizedFieldMapper { private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(IpFieldMapper.class); diff --git a/server/src/main/java/org/opensearch/index/mapper/KeywordFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/KeywordFieldMapper.java index 4206b29e23456..cde2fb1b93668 100644 --- a/server/src/main/java/org/opensearch/index/mapper/KeywordFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/KeywordFieldMapper.java @@ -61,6 +61,8 @@ /** * A field mapper for keywords. This mapper accepts strings and indexes them as-is. + * + * @opensearch.internal */ public final class KeywordFieldMapper extends ParametrizedFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeFieldMapper.java index b8595647c328c..fc64d173d75f2 100644 --- a/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeFieldMapper.java @@ -93,6 +93,8 @@ * "field" : "POLYGON ((100.0 0.0, 101.0 0.0, 101.0 1.0, 100.0 1.0, 100.0 0.0)) * * @deprecated use {@link GeoShapeFieldMapper} + * + * @opensearch.internal */ @Deprecated public class LegacyGeoShapeFieldMapper extends AbstractShapeGeometryFieldMapper, Shape> { diff --git a/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeIndexer.java b/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeIndexer.java index d5342c2510100..8565599404bb0 100644 --- a/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeIndexer.java +++ b/server/src/main/java/org/opensearch/index/mapper/LegacyGeoShapeIndexer.java @@ -43,6 +43,14 @@ import java.util.Arrays; import java.util.List; +/** + * Indexer for legacy prefix trees + * + * @opensearch.internal + * + * @deprecated will be removed in the next version + */ +@Deprecated public class LegacyGeoShapeIndexer implements AbstractGeometryFieldMapper.Indexer, Shape> { private LegacyGeoShapeFieldMapper.GeoShapeFieldType fieldType; diff --git a/server/src/main/java/org/opensearch/index/mapper/MappedFieldType.java b/server/src/main/java/org/opensearch/index/mapper/MappedFieldType.java index 645115bfe26e2..e37325b246727 100644 --- a/server/src/main/java/org/opensearch/index/mapper/MappedFieldType.java +++ b/server/src/main/java/org/opensearch/index/mapper/MappedFieldType.java @@ -77,6 +77,8 @@ /** * This defines the core properties and functions to operate on a field. + * + * @opensearch.internal */ public abstract class MappedFieldType { diff --git a/server/src/main/java/org/opensearch/index/mapper/Mapper.java b/server/src/main/java/org/opensearch/index/mapper/Mapper.java index f9f16a33a0c52..2f763ec0e35c1 100644 --- a/server/src/main/java/org/opensearch/index/mapper/Mapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/Mapper.java @@ -48,6 +48,11 @@ import java.util.function.Function; import java.util.function.Supplier; +/** + * The foundation OpenSearch mapper + * + * @opensearch.internal + */ public abstract class Mapper implements ToXContentFragment, Iterable { public static class BuilderContext { diff --git a/server/src/main/java/org/opensearch/index/mapper/MapperException.java b/server/src/main/java/org/opensearch/index/mapper/MapperException.java index 0276aa6431c6d..51f4614b883a3 100644 --- a/server/src/main/java/org/opensearch/index/mapper/MapperException.java +++ b/server/src/main/java/org/opensearch/index/mapper/MapperException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown for any mapping errors + * + * @opensearch.internal + */ public class MapperException extends OpenSearchException { public MapperException(StreamInput in) throws IOException { super(in); diff --git a/server/src/main/java/org/opensearch/index/mapper/MapperParsingException.java b/server/src/main/java/org/opensearch/index/mapper/MapperParsingException.java index dafe1e165038b..d293b69838b6b 100644 --- a/server/src/main/java/org/opensearch/index/mapper/MapperParsingException.java +++ b/server/src/main/java/org/opensearch/index/mapper/MapperParsingException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if there are any errors parsing mappings + * + * @opensearch.internal + */ public class MapperParsingException extends MapperException { public MapperParsingException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/index/mapper/MapperService.java b/server/src/main/java/org/opensearch/index/mapper/MapperService.java index 33c6ff2bc4391..980259fec7e44 100644 --- a/server/src/main/java/org/opensearch/index/mapper/MapperService.java +++ b/server/src/main/java/org/opensearch/index/mapper/MapperService.java @@ -87,6 +87,11 @@ import static java.util.Collections.emptyMap; import static java.util.Collections.unmodifiableMap; +/** + * The core field mapping service + * + * @opensearch.internal + */ public class MapperService extends AbstractIndexComponent implements Closeable { /** diff --git a/server/src/main/java/org/opensearch/index/mapper/Mapping.java b/server/src/main/java/org/opensearch/index/mapper/Mapping.java index 90d6c6a2ddcc0..292ee499ede7c 100644 --- a/server/src/main/java/org/opensearch/index/mapper/Mapping.java +++ b/server/src/main/java/org/opensearch/index/mapper/Mapping.java @@ -54,6 +54,8 @@ /** * Wrapper around everything that defines a mapping, without references to * utility classes like MapperService, ... + * + * @opensearch.internal */ public final class Mapping implements ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/index/mapper/MappingLookup.java b/server/src/main/java/org/opensearch/index/mapper/MappingLookup.java index 38f825e18904d..5bccb4f6e827e 100644 --- a/server/src/main/java/org/opensearch/index/mapper/MappingLookup.java +++ b/server/src/main/java/org/opensearch/index/mapper/MappingLookup.java @@ -45,6 +45,11 @@ import java.util.Map; import java.util.stream.Stream; +/** + * Looks up a mapping for a field + * + * @opensearch.internal + */ public final class MappingLookup implements Iterable { /** Full field name to mapper */ diff --git a/server/src/main/java/org/opensearch/index/mapper/MetadataFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/MetadataFieldMapper.java index 7fca0610c046d..b4142de9b097c 100644 --- a/server/src/main/java/org/opensearch/index/mapper/MetadataFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/MetadataFieldMapper.java @@ -42,6 +42,8 @@ /** * A mapper for a builtin field containing metadata about a document. + * + * @opensearch.internal */ public abstract class MetadataFieldMapper extends ParametrizedFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/NestedPathFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/NestedPathFieldMapper.java index f420897ca187f..6b441df47b9fd 100644 --- a/server/src/main/java/org/opensearch/index/mapper/NestedPathFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/NestedPathFieldMapper.java @@ -21,6 +21,11 @@ import java.util.Collections; +/** + * Replacement for TypesFieldMapper used in nested fields + * + * @opensearch.internal + */ public class NestedPathFieldMapper extends MetadataFieldMapper { // OpenSearch version 2.0 removed types; this name is used for bwc public static final String LEGACY_NAME = "_type"; diff --git a/server/src/main/java/org/opensearch/index/mapper/NumberFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/NumberFieldMapper.java index bf7b1ae70c711..343a1235ba8e6 100644 --- a/server/src/main/java/org/opensearch/index/mapper/NumberFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/NumberFieldMapper.java @@ -77,7 +77,11 @@ import java.util.function.Function; import java.util.function.Supplier; -/** A {@link FieldMapper} for numeric types: byte, short, int, long, float and double. */ +/** + * A {@link FieldMapper} for numeric types: byte, short, int, long, float and double. + * + * @opensearch.internal + */ public class NumberFieldMapper extends ParametrizedFieldMapper { public static final Setting COERCE_SETTING = Setting.boolSetting("index.mapping.coerce", true, Property.IndexScope); diff --git a/server/src/main/java/org/opensearch/index/mapper/ObjectMapper.java b/server/src/main/java/org/opensearch/index/mapper/ObjectMapper.java index d3c2e7f1e5372..5fbebc0206270 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ObjectMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/ObjectMapper.java @@ -56,6 +56,11 @@ import java.util.Locale; import java.util.Map; +/** + * Field mapper for object field types + * + * @opensearch.internal + */ public class ObjectMapper extends Mapper implements Cloneable { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(ObjectMapper.class); diff --git a/server/src/main/java/org/opensearch/index/mapper/ParametrizedFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/ParametrizedFieldMapper.java index 6e0b2613cf4ff..5697d2fffcf3b 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ParametrizedFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/ParametrizedFieldMapper.java @@ -70,6 +70,8 @@ * * Subclasses should implement a {@link Builder} that is returned from the * {@link #getMergeBuilder()} method, initialised with the existing builder. + * + * @opensearch.internal */ public abstract class ParametrizedFieldMapper extends FieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/ParseContext.java b/server/src/main/java/org/opensearch/index/mapper/ParseContext.java index 50295626393ad..3dd68bb6d7c58 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ParseContext.java +++ b/server/src/main/java/org/opensearch/index/mapper/ParseContext.java @@ -49,6 +49,11 @@ import java.util.List; import java.util.Set; +/** + * Holds the context at parse time + * + * @opensearch.internal + */ public abstract class ParseContext implements Iterable { /** Fork of {@link org.apache.lucene.document.Document} with additional functionality. */ diff --git a/server/src/main/java/org/opensearch/index/mapper/ParsedDocument.java b/server/src/main/java/org/opensearch/index/mapper/ParsedDocument.java index 6991db3306ea7..c17444740ca30 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ParsedDocument.java +++ b/server/src/main/java/org/opensearch/index/mapper/ParsedDocument.java @@ -42,6 +42,8 @@ /** * The result of parsing a document. + * + * @opensearch.internal */ public class ParsedDocument { diff --git a/server/src/main/java/org/opensearch/index/mapper/RangeFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/RangeFieldMapper.java index 2568009cfc0d5..adc0cbaae7d1c 100644 --- a/server/src/main/java/org/opensearch/index/mapper/RangeFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/RangeFieldMapper.java @@ -77,7 +77,11 @@ import static org.opensearch.index.query.RangeQueryBuilder.LTE_FIELD; import static org.opensearch.index.query.RangeQueryBuilder.LT_FIELD; -/** A {@link FieldMapper} for indexing numeric and date ranges, and creating queries */ +/** + * A {@link FieldMapper} for indexing numeric and date ranges, and creating queries + * + * @opensearch.internal + */ public class RangeFieldMapper extends ParametrizedFieldMapper { public static final boolean DEFAULT_INCLUDE_UPPER = true; public static final boolean DEFAULT_INCLUDE_LOWER = true; diff --git a/server/src/main/java/org/opensearch/index/mapper/RangeType.java b/server/src/main/java/org/opensearch/index/mapper/RangeType.java index 5f666dece7ed2..ce31b5e6ac5df 100644 --- a/server/src/main/java/org/opensearch/index/mapper/RangeType.java +++ b/server/src/main/java/org/opensearch/index/mapper/RangeType.java @@ -66,7 +66,11 @@ import java.util.Set; import java.util.function.BiFunction; -/** Enum defining the type of range */ +/** + * Enum defining the type of range + * + * @opensearch.internal + */ public enum RangeType { IP("ip_range", LengthType.FIXED_16) { @Override diff --git a/server/src/main/java/org/opensearch/index/mapper/RootObjectMapper.java b/server/src/main/java/org/opensearch/index/mapper/RootObjectMapper.java index b83ce6022b012..cee9ba9f7507c 100644 --- a/server/src/main/java/org/opensearch/index/mapper/RootObjectMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/RootObjectMapper.java @@ -57,6 +57,11 @@ import static org.opensearch.common.xcontent.support.XContentMapValues.nodeBooleanValue; import static org.opensearch.index.mapper.TypeParsers.parseDateTimeFormatter; +/** + * The root object mapper for a document + * + * @opensearch.internal + */ public class RootObjectMapper extends ObjectMapper { private static final DeprecationLogger DEPRECATION_LOGGER = DeprecationLogger.getLogger(RootObjectMapper.class); diff --git a/server/src/main/java/org/opensearch/index/mapper/RoutingFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/RoutingFieldMapper.java index e487673b5c9da..f8bc833983391 100644 --- a/server/src/main/java/org/opensearch/index/mapper/RoutingFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/RoutingFieldMapper.java @@ -42,6 +42,11 @@ import java.util.Collections; import java.util.List; +/** + * Internal field mapper for _routing fields + * + * @opensearch.internal + */ public class RoutingFieldMapper extends MetadataFieldMapper { public static final String NAME = "_routing"; diff --git a/server/src/main/java/org/opensearch/index/mapper/SeqNoFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/SeqNoFieldMapper.java index 490e1a31ae72b..9b2e561acc841 100644 --- a/server/src/main/java/org/opensearch/index/mapper/SeqNoFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/SeqNoFieldMapper.java @@ -65,7 +65,8 @@ * identical seq# values for two document copies. The primary term is stored as * a doc value field without being indexed, since it is only intended for use * as a key-value lookup. - + * + * @opensearch.internal */ public class SeqNoFieldMapper extends MetadataFieldMapper { diff --git a/server/src/main/java/org/opensearch/index/mapper/SimpleMappedFieldType.java b/server/src/main/java/org/opensearch/index/mapper/SimpleMappedFieldType.java index 44c89211f5ef0..7ea5d49e234a5 100644 --- a/server/src/main/java/org/opensearch/index/mapper/SimpleMappedFieldType.java +++ b/server/src/main/java/org/opensearch/index/mapper/SimpleMappedFieldType.java @@ -42,6 +42,8 @@ /** * {@link MappedFieldType} base impl for field types that are neither dates nor ranges. + * + * @opensearch.internal */ public abstract class SimpleMappedFieldType extends MappedFieldType { diff --git a/server/src/main/java/org/opensearch/index/mapper/SourceFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/SourceFieldMapper.java index 8791c23e49051..4a5778db590dc 100644 --- a/server/src/main/java/org/opensearch/index/mapper/SourceFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/SourceFieldMapper.java @@ -60,6 +60,11 @@ import java.util.Map; import java.util.function.Function; +/** + * Internal field mapper for storing source (and recovery source) + * + * @opensearch.internal + */ public class SourceFieldMapper extends MetadataFieldMapper { public static final String NAME = "_source"; diff --git a/server/src/main/java/org/opensearch/index/mapper/SourceToParse.java b/server/src/main/java/org/opensearch/index/mapper/SourceToParse.java index 4aa8d3117bc9c..7993c3f0a3b36 100644 --- a/server/src/main/java/org/opensearch/index/mapper/SourceToParse.java +++ b/server/src/main/java/org/opensearch/index/mapper/SourceToParse.java @@ -39,6 +39,11 @@ import org.opensearch.common.bytes.BytesReference; import org.opensearch.common.xcontent.XContentType; +/** + * Stores the document source + * + * @opensearch.internal + */ public class SourceToParse { private final BytesReference source; diff --git a/server/src/main/java/org/opensearch/index/mapper/SourceValueFetcher.java b/server/src/main/java/org/opensearch/index/mapper/SourceValueFetcher.java index 9467f22afa8e8..d602fceeed041 100644 --- a/server/src/main/java/org/opensearch/index/mapper/SourceValueFetcher.java +++ b/server/src/main/java/org/opensearch/index/mapper/SourceValueFetcher.java @@ -48,6 +48,8 @@ * to implement value fetching. * * Field types that handle arrays directly should instead use {@link ArraySourceValueFetcher}. + * + * @opensearch.internal */ public abstract class SourceValueFetcher implements ValueFetcher { private final Set sourcePaths; diff --git a/server/src/main/java/org/opensearch/index/mapper/StrictDynamicMappingException.java b/server/src/main/java/org/opensearch/index/mapper/StrictDynamicMappingException.java index 6e26ad46eecdc..6c2f10626541f 100644 --- a/server/src/main/java/org/opensearch/index/mapper/StrictDynamicMappingException.java +++ b/server/src/main/java/org/opensearch/index/mapper/StrictDynamicMappingException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown when mapping is set to `STRICT` + * + * @opensearch.internal + */ public class StrictDynamicMappingException extends MapperParsingException { public StrictDynamicMappingException(String path, String fieldName) { diff --git a/server/src/main/java/org/opensearch/index/mapper/StringFieldType.java b/server/src/main/java/org/opensearch/index/mapper/StringFieldType.java index 9aa6bf09a1176..fa9c02c3cf14e 100644 --- a/server/src/main/java/org/opensearch/index/mapper/StringFieldType.java +++ b/server/src/main/java/org/opensearch/index/mapper/StringFieldType.java @@ -59,7 +59,10 @@ /** Base class for {@link MappedFieldType} implementations that use the same * representation for internal index terms as the external representation so * that partial matching queries such as prefix, wildcard and fuzzy queries - * can be implemented. */ + * can be implemented. + * + * @opensearch.internal + */ public abstract class StringFieldType extends TermBasedFieldType { private static final Pattern WILDCARD_PATTERN = Pattern.compile("(\\\\.)|([?*]+)"); diff --git a/server/src/main/java/org/opensearch/index/mapper/TermBasedFieldType.java b/server/src/main/java/org/opensearch/index/mapper/TermBasedFieldType.java index 77efea3c20b6c..78dae2d2c27fc 100644 --- a/server/src/main/java/org/opensearch/index/mapper/TermBasedFieldType.java +++ b/server/src/main/java/org/opensearch/index/mapper/TermBasedFieldType.java @@ -46,7 +46,10 @@ import java.util.Map; /** Base {@link MappedFieldType} implementation for a field that is indexed - * with the inverted index. */ + * with the inverted index. + * + * @opensearch.internal + */ public abstract class TermBasedFieldType extends SimpleMappedFieldType { public TermBasedFieldType( diff --git a/server/src/main/java/org/opensearch/index/mapper/TextFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/TextFieldMapper.java index 360240eb9d59c..bad09e76ecab6 100644 --- a/server/src/main/java/org/opensearch/index/mapper/TextFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/TextFieldMapper.java @@ -102,7 +102,11 @@ import java.util.function.IntPredicate; import java.util.function.Supplier; -/** A {@link FieldMapper} for full-text fields. */ +/** + * A {@link FieldMapper} for full-text fields. + * + * @opensearch.internal + */ public class TextFieldMapper extends ParametrizedFieldMapper { public static final String CONTENT_TYPE = "text"; diff --git a/server/src/main/java/org/opensearch/index/mapper/TextParams.java b/server/src/main/java/org/opensearch/index/mapper/TextParams.java index 0f764c298d912..f8fd02edafb11 100644 --- a/server/src/main/java/org/opensearch/index/mapper/TextParams.java +++ b/server/src/main/java/org/opensearch/index/mapper/TextParams.java @@ -47,6 +47,8 @@ /** * Utility functions for text mapper parameters + * + * @opensearch.internal */ public final class TextParams { diff --git a/server/src/main/java/org/opensearch/index/mapper/TextSearchInfo.java b/server/src/main/java/org/opensearch/index/mapper/TextSearchInfo.java index e341711621d41..79cb5f1ab2a54 100644 --- a/server/src/main/java/org/opensearch/index/mapper/TextSearchInfo.java +++ b/server/src/main/java/org/opensearch/index/mapper/TextSearchInfo.java @@ -40,6 +40,8 @@ /** * Encapsulates information about how to perform text searches over a field + * + * @opensearch.internal */ public class TextSearchInfo { diff --git a/server/src/main/java/org/opensearch/index/mapper/TypeParsers.java b/server/src/main/java/org/opensearch/index/mapper/TypeParsers.java index 7f0451cc2fa84..5c1b1428f6137 100644 --- a/server/src/main/java/org/opensearch/index/mapper/TypeParsers.java +++ b/server/src/main/java/org/opensearch/index/mapper/TypeParsers.java @@ -51,6 +51,11 @@ import static org.opensearch.common.xcontent.support.XContentMapValues.nodeFloatValue; import static org.opensearch.common.xcontent.support.XContentMapValues.nodeStringValue; +/** + * Foundation type parsers + * + * @opensearch.internal + */ public class TypeParsers { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(TypeParsers.class); diff --git a/server/src/main/java/org/opensearch/index/mapper/Uid.java b/server/src/main/java/org/opensearch/index/mapper/Uid.java index fa149b9dcac46..fa6094ab4ed59 100644 --- a/server/src/main/java/org/opensearch/index/mapper/Uid.java +++ b/server/src/main/java/org/opensearch/index/mapper/Uid.java @@ -38,6 +38,11 @@ import java.util.Arrays; import java.util.Base64; +/** + * A documents OpenSearch id + * + * @opensearch.internal + */ public final class Uid { public static final char DELIMITER = '#'; diff --git a/server/src/main/java/org/opensearch/index/mapper/ValueFetcher.java b/server/src/main/java/org/opensearch/index/mapper/ValueFetcher.java index 99d2f33701229..d1cea3fe7f1b0 100644 --- a/server/src/main/java/org/opensearch/index/mapper/ValueFetcher.java +++ b/server/src/main/java/org/opensearch/index/mapper/ValueFetcher.java @@ -42,6 +42,8 @@ /** * A helper class for fetching field values during the {@link FetchFieldsPhase}. Each {@link MappedFieldType} * is in charge of defining a value fetcher through {@link MappedFieldType#valueFetcher}. + * + * @opensearch.internal */ public interface ValueFetcher { /** diff --git a/server/src/main/java/org/opensearch/index/mapper/VersionFieldMapper.java b/server/src/main/java/org/opensearch/index/mapper/VersionFieldMapper.java index e601894105b59..f5c36a3d30495 100644 --- a/server/src/main/java/org/opensearch/index/mapper/VersionFieldMapper.java +++ b/server/src/main/java/org/opensearch/index/mapper/VersionFieldMapper.java @@ -42,7 +42,11 @@ import java.util.Collections; -/** Mapper for the _version field. */ +/** + * Mapper for the _version field. + * + * @opensearch.internal + */ public class VersionFieldMapper extends MetadataFieldMapper { public static final String NAME = "_version"; diff --git a/server/src/main/java/org/opensearch/index/merge/MergeStats.java b/server/src/main/java/org/opensearch/index/merge/MergeStats.java index 6ef4ed77a8269..2bd6bc88b8659 100644 --- a/server/src/main/java/org/opensearch/index/merge/MergeStats.java +++ b/server/src/main/java/org/opensearch/index/merge/MergeStats.java @@ -42,6 +42,11 @@ import java.io.IOException; +/** + * Stores stats about a merge process + * + * @opensearch.internal + */ public class MergeStats implements Writeable, ToXContentFragment { private long total; diff --git a/server/src/main/java/org/opensearch/index/merge/OnGoingMerge.java b/server/src/main/java/org/opensearch/index/merge/OnGoingMerge.java index c42d883d612e7..59edc54d2f1ca 100644 --- a/server/src/main/java/org/opensearch/index/merge/OnGoingMerge.java +++ b/server/src/main/java/org/opensearch/index/merge/OnGoingMerge.java @@ -39,6 +39,8 @@ /** * Represents a single on going merge within an index. + * + * @opensearch.internal */ public class OnGoingMerge { diff --git a/server/src/main/java/org/opensearch/index/query/AbstractGeometryQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/AbstractGeometryQueryBuilder.java index 9281f1767d72d..a72447402d3c5 100644 --- a/server/src/main/java/org/opensearch/index/query/AbstractGeometryQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/AbstractGeometryQueryBuilder.java @@ -64,6 +64,8 @@ /** * Base {@link QueryBuilder} that builds a Geometry Query + * + * @opensearch.internal */ public abstract class AbstractGeometryQueryBuilder> extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/AbstractQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/AbstractQueryBuilder.java index 3ab3d099f0778..0265084462f6d 100644 --- a/server/src/main/java/org/opensearch/index/query/AbstractQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/AbstractQueryBuilder.java @@ -62,6 +62,8 @@ /** * Base class for all classes producing lucene queries. * Supports conversion to BytesReference and creation of lucene Query objects. + * + * @opensearch.internal */ public abstract class AbstractQueryBuilder> implements QueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/BaseTermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/BaseTermQueryBuilder.java index 6790d6682a799..af377834c6d76 100644 --- a/server/src/main/java/org/opensearch/index/query/BaseTermQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/BaseTermQueryBuilder.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Base class for a TermQueryBuilder + * + * @opensearch.internal + */ public abstract class BaseTermQueryBuilder> extends AbstractQueryBuilder { public static final ParseField VALUE_FIELD = new ParseField("value"); diff --git a/server/src/main/java/org/opensearch/index/query/BoolQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/BoolQueryBuilder.java index b23231806ea1a..d335a47bf2289 100644 --- a/server/src/main/java/org/opensearch/index/query/BoolQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/BoolQueryBuilder.java @@ -59,6 +59,8 @@ /** * A Query that matches documents matching boolean combinations of other queries. + * + * @opensearch.internal */ public class BoolQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "bool"; diff --git a/server/src/main/java/org/opensearch/index/query/BoostingQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/BoostingQueryBuilder.java index cb50bcd6a3aa7..531858aa0b54b 100644 --- a/server/src/main/java/org/opensearch/index/query/BoostingQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/BoostingQueryBuilder.java @@ -56,6 +56,8 @@ * are simply used to lessen the scores. Documents that match the negativeQuery have their score * multiplied by the supplied "boost" parameter, so this should be less than 1 to achieve a * demoting effect + * + * @opensearch.internal */ public class BoostingQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "boosting"; diff --git a/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java index b77b512518186..9096492c66481 100644 --- a/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/CommonTermsQueryBuilder.java @@ -63,6 +63,8 @@ * * @deprecated Since max_optimization optimization landed in 7.0, normal MatchQuery * will achieve the same result without any configuration. + * + * @opensearch.internal */ @Deprecated public class CommonTermsQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/ConstantScoreQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/ConstantScoreQueryBuilder.java index 5901e32249158..d3356592b7981 100644 --- a/server/src/main/java/org/opensearch/index/query/ConstantScoreQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/ConstantScoreQueryBuilder.java @@ -48,6 +48,8 @@ /** * A query that wraps a filter and simply returns a constant score equal to the * query boost for every document in the filter. + * + * @opensearch.internal */ public class ConstantScoreQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "constant_score"; diff --git a/server/src/main/java/org/opensearch/index/query/DateRangeIncludingNowQuery.java b/server/src/main/java/org/opensearch/index/query/DateRangeIncludingNowQuery.java index cd4cccc966014..2a7dbf314103d 100644 --- a/server/src/main/java/org/opensearch/index/query/DateRangeIncludingNowQuery.java +++ b/server/src/main/java/org/opensearch/index/query/DateRangeIncludingNowQuery.java @@ -44,6 +44,8 @@ * A simple wrapper class that indicates that the wrapped query has made use of NOW * when parsing its datemath. Useful for preprocessors such as the percolator that * need to know when not to extract dates from the query. + * + * @opensearch.internal */ public class DateRangeIncludingNowQuery extends Query { diff --git a/server/src/main/java/org/opensearch/index/query/DisMaxQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/DisMaxQueryBuilder.java index f5c97fde14baa..87a707fd0a43d 100644 --- a/server/src/main/java/org/opensearch/index/query/DisMaxQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/DisMaxQueryBuilder.java @@ -53,6 +53,8 @@ * A query that generates the union of documents produced by its sub-queries, and that scores each document * with the maximum score for that document as produced by any sub-query, plus a tie breaking increment for any * additional matching sub-queries. + * + * @opensearch.internal */ public class DisMaxQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "dis_max"; diff --git a/server/src/main/java/org/opensearch/index/query/DistanceFeatureQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/DistanceFeatureQueryBuilder.java index 9f6322234f32d..dee6e3f8a762f 100644 --- a/server/src/main/java/org/opensearch/index/query/DistanceFeatureQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/DistanceFeatureQueryBuilder.java @@ -54,6 +54,8 @@ /** * A query to boost scores based on their proximity to the given origin * for date, date_nanos and geo_point field types + * + * @opensearch.internal */ public class DistanceFeatureQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "distance_feature"; diff --git a/server/src/main/java/org/opensearch/index/query/ExistsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/ExistsQueryBuilder.java index 75c54093a8bd3..135a9788ab039 100644 --- a/server/src/main/java/org/opensearch/index/query/ExistsQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/ExistsQueryBuilder.java @@ -58,6 +58,8 @@ /** * Constructs a query that only match on documents that the field has a value in them. + * + * @opensearch.internal */ public class ExistsQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "exists"; diff --git a/server/src/main/java/org/opensearch/index/query/FieldMaskingSpanQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/FieldMaskingSpanQueryBuilder.java index 1b095c6130a7c..41cce48cd3d7f 100644 --- a/server/src/main/java/org/opensearch/index/query/FieldMaskingSpanQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/FieldMaskingSpanQueryBuilder.java @@ -47,6 +47,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Query builder for field masking span query + * + * @opensearch.internal + */ public class FieldMaskingSpanQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final ParseField SPAN_FIELD_MASKING_FIELD = new ParseField("span_field_masking", "field_masking_span"); diff --git a/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java index e11cb5fabfed0..2def2dab53450 100644 --- a/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/FuzzyQueryBuilder.java @@ -52,6 +52,8 @@ /** * A Query that does fuzzy matching for a specific value. + * + * @opensearch.internal */ public class FuzzyQueryBuilder extends AbstractQueryBuilder implements MultiTermQueryBuilder { public static final String NAME = "fuzzy"; diff --git a/server/src/main/java/org/opensearch/index/query/GeoBoundingBoxQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoBoundingBoxQueryBuilder.java index 879ad07ca81fd..cafdec91aef15 100644 --- a/server/src/main/java/org/opensearch/index/query/GeoBoundingBoxQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/GeoBoundingBoxQueryBuilder.java @@ -63,6 +63,8 @@ * * This query can only operate on fields of type geo_point that have latitude and longitude * enabled. + * + * @opensearch.internal * */ public class GeoBoundingBoxQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "geo_bounding_box"; diff --git a/server/src/main/java/org/opensearch/index/query/GeoDistanceQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoDistanceQueryBuilder.java index 9fb3ef262ab63..6859bd0bffa7e 100644 --- a/server/src/main/java/org/opensearch/index/query/GeoDistanceQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/GeoDistanceQueryBuilder.java @@ -60,6 +60,8 @@ /** * Filter results of a query to include only those within a specific distance to some * geo point. + * + * @opensearch.internal */ public class GeoDistanceQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "geo_distance"; diff --git a/server/src/main/java/org/opensearch/index/query/GeoExecType.java b/server/src/main/java/org/opensearch/index/query/GeoExecType.java index da1c26e0abbd9..8b58b50352384 100644 --- a/server/src/main/java/org/opensearch/index/query/GeoExecType.java +++ b/server/src/main/java/org/opensearch/index/query/GeoExecType.java @@ -39,7 +39,11 @@ import java.io.IOException; -/** Specifies how a geo query should be run. */ +/** + * Specifies how a geo query should be run. + * + * @opensearch.internal + */ public enum GeoExecType implements Writeable { MEMORY(0), diff --git a/server/src/main/java/org/opensearch/index/query/GeoPolygonQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoPolygonQueryBuilder.java index c6a3fbded13c0..2841cd7670aa5 100644 --- a/server/src/main/java/org/opensearch/index/query/GeoPolygonQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/GeoPolygonQueryBuilder.java @@ -56,6 +56,11 @@ import java.util.List; import java.util.Objects; +/** + * Query builder for polygon queries + * + * @opensearch.internal + */ public class GeoPolygonQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "geo_polygon"; diff --git a/server/src/main/java/org/opensearch/index/query/GeoShapeQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/GeoShapeQueryBuilder.java index 161c6e64c7bf3..589c733eafe00 100644 --- a/server/src/main/java/org/opensearch/index/query/GeoShapeQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/GeoShapeQueryBuilder.java @@ -57,6 +57,8 @@ * can be applied to any {@link MappedFieldType} that implements {@link GeoShapeQueryable}. * * GeoJson and WKT shape definitions are supported + * + * @opensearch.internal */ public class GeoShapeQueryBuilder extends AbstractGeometryQueryBuilder { public static final String NAME = "geo_shape"; diff --git a/server/src/main/java/org/opensearch/index/query/GeoValidationMethod.java b/server/src/main/java/org/opensearch/index/query/GeoValidationMethod.java index 45c90727fbb8b..eee6782a1f85e 100644 --- a/server/src/main/java/org/opensearch/index/query/GeoValidationMethod.java +++ b/server/src/main/java/org/opensearch/index/query/GeoValidationMethod.java @@ -46,7 +46,9 @@ * On STRICT validation invalid coordinates cause an exception to be thrown. * On IGNORE_MALFORMED invalid coordinates are being accepted. * On COERCE invalid coordinates are being corrected to the most likely valid coordinate. - * */ + * + * @opensearch.internal + */ public enum GeoValidationMethod implements Writeable { COERCE, IGNORE_MALFORMED, diff --git a/server/src/main/java/org/opensearch/index/query/IdsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/IdsQueryBuilder.java index 724425957f75a..d76a2b98b951a 100644 --- a/server/src/main/java/org/opensearch/index/query/IdsQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/IdsQueryBuilder.java @@ -58,6 +58,8 @@ /** * A query that will return only documents matching specific ids (and a type). + * + * @opensearch.internal */ public class IdsQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "ids"; diff --git a/server/src/main/java/org/opensearch/index/query/InnerHitBuilder.java b/server/src/main/java/org/opensearch/index/query/InnerHitBuilder.java index a1e041ba24080..a185894bbd94a 100644 --- a/server/src/main/java/org/opensearch/index/query/InnerHitBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/InnerHitBuilder.java @@ -64,6 +64,9 @@ import static org.opensearch.common.xcontent.XContentParser.Token.END_OBJECT; +/** + * Query builder for inner hits + */ public final class InnerHitBuilder implements Writeable, ToXContentObject { public static final ParseField NAME_FIELD = new ParseField("name"); diff --git a/server/src/main/java/org/opensearch/index/query/InnerHitContextBuilder.java b/server/src/main/java/org/opensearch/index/query/InnerHitContextBuilder.java index 10efb18dc0cfa..8c4c001ffb135 100644 --- a/server/src/main/java/org/opensearch/index/query/InnerHitContextBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/InnerHitContextBuilder.java @@ -49,6 +49,8 @@ /** * A builder for {@link InnerHitsContext.InnerHitSubContext} + * + * @opensearch.internal */ public abstract class InnerHitContextBuilder { protected final QueryBuilder query; diff --git a/server/src/main/java/org/opensearch/index/query/IntervalBuilder.java b/server/src/main/java/org/opensearch/index/query/IntervalBuilder.java index e91adc5abe27a..0a13900d110ab 100644 --- a/server/src/main/java/org/opensearch/index/query/IntervalBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/IntervalBuilder.java @@ -57,6 +57,8 @@ /** * Constructs an IntervalsSource based on analyzed text + * + * @opensearch.internal */ public class IntervalBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/IntervalFilterScript.java b/server/src/main/java/org/opensearch/index/query/IntervalFilterScript.java index 0e9ed2cc557f6..a5513e560d15f 100644 --- a/server/src/main/java/org/opensearch/index/query/IntervalFilterScript.java +++ b/server/src/main/java/org/opensearch/index/query/IntervalFilterScript.java @@ -38,6 +38,8 @@ /** * Base class for scripts used as interval filters, see {@link IntervalsSourceProvider.IntervalFilter} + * + * @opensearch.internal */ public abstract class IntervalFilterScript { diff --git a/server/src/main/java/org/opensearch/index/query/IntervalMode.java b/server/src/main/java/org/opensearch/index/query/IntervalMode.java index f0489bf452678..9e4d07aa9c943 100644 --- a/server/src/main/java/org/opensearch/index/query/IntervalMode.java +++ b/server/src/main/java/org/opensearch/index/query/IntervalMode.java @@ -15,6 +15,11 @@ import java.io.IOException; +/** + * Mode for Text and Mapped Field Types + * + * @opensearch.internal + */ public enum IntervalMode implements Writeable { ORDERED(0), UNORDERED(1), diff --git a/server/src/main/java/org/opensearch/index/query/IntervalQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/IntervalQueryBuilder.java index 13dd60d3c2a0f..fe0dc34f994a0 100644 --- a/server/src/main/java/org/opensearch/index/query/IntervalQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/IntervalQueryBuilder.java @@ -49,6 +49,8 @@ /** * Builder for {@link IntervalQuery} + * + * @opensearch.internal */ public class IntervalQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/IntervalsSourceProvider.java b/server/src/main/java/org/opensearch/index/query/IntervalsSourceProvider.java index b53dfc32d7006..9409a264fa8a0 100644 --- a/server/src/main/java/org/opensearch/index/query/IntervalsSourceProvider.java +++ b/server/src/main/java/org/opensearch/index/query/IntervalsSourceProvider.java @@ -77,6 +77,8 @@ * to a proximity source (phrase, ordered, unordered, unordered without overlaps depending on how * strict the matching should be); {@link Combine}, which allows proximity queries * between different sub-sources; and {@link Disjunction}. + * + * @opensearch.internal */ public abstract class IntervalsSourceProvider implements NamedWriteable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/index/query/LegacyGeoShapeQueryProcessor.java b/server/src/main/java/org/opensearch/index/query/LegacyGeoShapeQueryProcessor.java index d16bdb8ac6327..189f42ae59020 100644 --- a/server/src/main/java/org/opensearch/index/query/LegacyGeoShapeQueryProcessor.java +++ b/server/src/main/java/org/opensearch/index/query/LegacyGeoShapeQueryProcessor.java @@ -75,6 +75,14 @@ import static org.opensearch.search.SearchService.ALLOW_EXPENSIVE_QUERIES; +/** + * Query Processor for Legacy Geo Shape types (prefix trees) + * + * @opensearch.internal + * + * @deprecated this will be removed in a future release + */ +@Deprecated public class LegacyGeoShapeQueryProcessor { private AbstractShapeGeometryFieldMapper.AbstractShapeGeometryFieldType ft; diff --git a/server/src/main/java/org/opensearch/index/query/MatchAllQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchAllQueryBuilder.java index ba51ec82e4667..7192b190ffed9 100644 --- a/server/src/main/java/org/opensearch/index/query/MatchAllQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MatchAllQueryBuilder.java @@ -45,6 +45,8 @@ /** * A query that matches on all documents. + * + * @opensearch.internal */ public class MatchAllQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "match_all"; diff --git a/server/src/main/java/org/opensearch/index/query/MatchBoolPrefixQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchBoolPrefixQueryBuilder.java index b6a85e2936b20..f8f84c52309d5 100644 --- a/server/src/main/java/org/opensearch/index/query/MatchBoolPrefixQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MatchBoolPrefixQueryBuilder.java @@ -58,6 +58,8 @@ /** * The boolean prefix query analyzes the input text and creates a boolean query containing a Term query for each term, except * for the last term, which is used to create a prefix query + * + * @opensearch.internal */ public class MatchBoolPrefixQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/MatchNoneQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchNoneQueryBuilder.java index f71f1fac9094d..95b8569182cff 100644 --- a/server/src/main/java/org/opensearch/index/query/MatchNoneQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MatchNoneQueryBuilder.java @@ -44,6 +44,8 @@ /** * A query that matches no document. + * + * @opensearch.internal */ public class MatchNoneQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "match_none"; diff --git a/server/src/main/java/org/opensearch/index/query/MatchPhrasePrefixQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchPhrasePrefixQueryBuilder.java index 3ee3c25837f37..dd727d6ffdc2b 100644 --- a/server/src/main/java/org/opensearch/index/query/MatchPhrasePrefixQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MatchPhrasePrefixQueryBuilder.java @@ -50,6 +50,8 @@ /** * Match query is a query that analyzes the text and constructs a phrase prefix * query as the result of the analysis. + * + * @opensearch.internal */ public class MatchPhrasePrefixQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "match_phrase_prefix"; diff --git a/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java index 03d00841db79a..815ad5e349183 100644 --- a/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MatchPhraseQueryBuilder.java @@ -49,6 +49,8 @@ /** * Match query is a query that analyzes the text and constructs a phrase query * as the result of the analysis. + * + * @opensearch.internal */ public class MatchPhraseQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "match_phrase"; diff --git a/server/src/main/java/org/opensearch/index/query/MatchQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MatchQueryBuilder.java index 54c0f79dbac92..380e8722daca9 100644 --- a/server/src/main/java/org/opensearch/index/query/MatchQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MatchQueryBuilder.java @@ -53,6 +53,8 @@ /** * Match query is a query that analyzes the text and constructs a query as the * result of the analysis. + * + * @opensearch.internal */ public class MatchQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java index 1ecc88387e549..fe13aef627f7b 100644 --- a/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MoreLikeThisQueryBuilder.java @@ -87,6 +87,8 @@ * A more like this query that finds documents that are "like" the provided set of document(s). * * The documents are provided as a set of strings and/or a list of {@link Item}. + * + * @opensearch.internal */ public class MoreLikeThisQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "more_like_this"; diff --git a/server/src/main/java/org/opensearch/index/query/MultiMatchQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MultiMatchQueryBuilder.java index 3a130f395539f..c3718f5520b23 100644 --- a/server/src/main/java/org/opensearch/index/query/MultiMatchQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MultiMatchQueryBuilder.java @@ -62,6 +62,8 @@ /** * Same as {@link MatchQueryBuilder} but supports multiple fields. + * + * @opensearch.internal */ public class MultiMatchQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/MultiTermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/MultiTermQueryBuilder.java index c88e8ce5fbfb0..b8e88da4741bb 100644 --- a/server/src/main/java/org/opensearch/index/query/MultiTermQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/MultiTermQueryBuilder.java @@ -31,6 +31,11 @@ package org.opensearch.index.query; +/** + * Base interface for multi term queries + * + * @opensearch.internal + */ public interface MultiTermQueryBuilder extends QueryBuilder { /** * Get the field name for this query. diff --git a/server/src/main/java/org/opensearch/index/query/NestedQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/NestedQueryBuilder.java index 52a7635d708f5..4e491b34e7b93 100644 --- a/server/src/main/java/org/opensearch/index/query/NestedQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/NestedQueryBuilder.java @@ -74,6 +74,11 @@ import static org.opensearch.search.SearchService.ALLOW_EXPENSIVE_QUERIES; import static org.opensearch.search.fetch.subphase.InnerHitsContext.intersect; +/** + * Query builder for nested queries + * + * @opensearch.internal + */ public class NestedQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "nested"; /** diff --git a/server/src/main/java/org/opensearch/index/query/Operator.java b/server/src/main/java/org/opensearch/index/query/Operator.java index 3963ca97a42d4..01fef29413484 100644 --- a/server/src/main/java/org/opensearch/index/query/Operator.java +++ b/server/src/main/java/org/opensearch/index/query/Operator.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.Locale; +/** + * Boolean operators + * + * @opensearch.internal + */ public enum Operator implements Writeable { OR, AND; diff --git a/server/src/main/java/org/opensearch/index/query/ParsedQuery.java b/server/src/main/java/org/opensearch/index/query/ParsedQuery.java index 57ed444660686..5d9f67ac365b9 100644 --- a/server/src/main/java/org/opensearch/index/query/ParsedQuery.java +++ b/server/src/main/java/org/opensearch/index/query/ParsedQuery.java @@ -41,6 +41,8 @@ /** * The result of parsing a query. + * + * @opensearch.internal */ public class ParsedQuery { private final Query query; diff --git a/server/src/main/java/org/opensearch/index/query/PrefixQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/PrefixQueryBuilder.java index 1d2a07c99374b..46d785756b855 100644 --- a/server/src/main/java/org/opensearch/index/query/PrefixQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/PrefixQueryBuilder.java @@ -54,6 +54,8 @@ /** * A Query that matches documents containing terms with a specified prefix. + * + * @opensearch.internal */ public class PrefixQueryBuilder extends AbstractQueryBuilder implements MultiTermQueryBuilder { public static final String NAME = "prefix"; diff --git a/server/src/main/java/org/opensearch/index/query/QueryBuilder.java b/server/src/main/java/org/opensearch/index/query/QueryBuilder.java index 0ae9668192242..44720881afaa3 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/QueryBuilder.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Foundation class for all OpenSearch query builders + * + * @opensearch.internal + */ public interface QueryBuilder extends NamedWriteable, ToXContentObject, Rewriteable { /** diff --git a/server/src/main/java/org/opensearch/index/query/QueryBuilders.java b/server/src/main/java/org/opensearch/index/query/QueryBuilders.java index 7ea12fdc6406b..0a5e846bd4e94 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryBuilders.java +++ b/server/src/main/java/org/opensearch/index/query/QueryBuilders.java @@ -53,6 +53,8 @@ /** * Utility class to create search queries. + * + * @opensearch.internal */ public final class QueryBuilders { diff --git a/server/src/main/java/org/opensearch/index/query/QueryParser.java b/server/src/main/java/org/opensearch/index/query/QueryParser.java index e01b2bd844282..d28858b110e8f 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryParser.java +++ b/server/src/main/java/org/opensearch/index/query/QueryParser.java @@ -38,6 +38,8 @@ /** * Defines a query parser that is able to parse {@link QueryBuilder}s from {@link org.opensearch.common.xcontent.XContent}. + * + * @opensearch.internal */ @FunctionalInterface public interface QueryParser { diff --git a/server/src/main/java/org/opensearch/index/query/QueryRewriteContext.java b/server/src/main/java/org/opensearch/index/query/QueryRewriteContext.java index 720ee077119d6..8e14d2372e9c5 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryRewriteContext.java +++ b/server/src/main/java/org/opensearch/index/query/QueryRewriteContext.java @@ -45,6 +45,8 @@ /** * Context object used to rewrite {@link QueryBuilder} instances into simplified version. + * + * @opensearch.internal */ public class QueryRewriteContext { private final NamedXContentRegistry xContentRegistry; diff --git a/server/src/main/java/org/opensearch/index/query/QueryShardContext.java b/server/src/main/java/org/opensearch/index/query/QueryShardContext.java index bfc0490e507db..fe2ed23b2b279 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryShardContext.java +++ b/server/src/main/java/org/opensearch/index/query/QueryShardContext.java @@ -89,6 +89,8 @@ /** * Context object used to create lucene queries on the shard level. + * + * @opensearch.internal */ public class QueryShardContext extends QueryRewriteContext { diff --git a/server/src/main/java/org/opensearch/index/query/QueryShardException.java b/server/src/main/java/org/opensearch/index/query/QueryShardException.java index 4b6c6d9aa8dd5..26865db0ab042 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryShardException.java +++ b/server/src/main/java/org/opensearch/index/query/QueryShardException.java @@ -42,6 +42,8 @@ /** * Exception that is thrown when creating lucene queries on the shard + * + * @opensearch.internal */ public class QueryShardException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java index 7d893f54ea64c..32337f5df34c5 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/QueryStringQueryBuilder.java @@ -66,6 +66,8 @@ * will use the {@link #defaultField(String)} set. The second, when one or more fields are added * (using {@link #field(String)}), will run the parsed query against the provided fields, and combine * them using Dismax. + * + * @opensearch.internal */ public class QueryStringQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/QueryValidationException.java b/server/src/main/java/org/opensearch/index/query/QueryValidationException.java index 8582ccbde4709..06680cabee0cd 100644 --- a/server/src/main/java/org/opensearch/index/query/QueryValidationException.java +++ b/server/src/main/java/org/opensearch/index/query/QueryValidationException.java @@ -38,6 +38,8 @@ /** * This exception can be used to indicate various reasons why validation of a query has failed. + * + * @opensearch.internal */ public class QueryValidationException extends ValidationException { diff --git a/server/src/main/java/org/opensearch/index/query/RangeQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/RangeQueryBuilder.java index 80b792d750546..5a3f0e80b24c9 100644 --- a/server/src/main/java/org/opensearch/index/query/RangeQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/RangeQueryBuilder.java @@ -55,6 +55,8 @@ /** * A Query that matches documents within an range of terms. + * + * @opensearch.internal */ public class RangeQueryBuilder extends AbstractQueryBuilder implements MultiTermQueryBuilder { public static final String NAME = "range"; diff --git a/server/src/main/java/org/opensearch/index/query/RegexpFlag.java b/server/src/main/java/org/opensearch/index/query/RegexpFlag.java index b1ee70a22bb17..926e00450a0c2 100644 --- a/server/src/main/java/org/opensearch/index/query/RegexpFlag.java +++ b/server/src/main/java/org/opensearch/index/query/RegexpFlag.java @@ -50,6 +50,8 @@ * * @see RegexpQueryBuilder#flags(RegexpFlag...) * @see RegexpQueryBuilder#flags(RegexpFlag...) + * + * @opensearch.internal */ public enum RegexpFlag { diff --git a/server/src/main/java/org/opensearch/index/query/RegexpQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/RegexpQueryBuilder.java index c8192557ef266..2c45cb179b227 100644 --- a/server/src/main/java/org/opensearch/index/query/RegexpQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/RegexpQueryBuilder.java @@ -57,6 +57,8 @@ /** * A Query that does fuzzy matching for a specific value. + * + * @opensearch.internal */ public class RegexpQueryBuilder extends AbstractQueryBuilder implements MultiTermQueryBuilder { public static final String NAME = "regexp"; diff --git a/server/src/main/java/org/opensearch/index/query/Rewriteable.java b/server/src/main/java/org/opensearch/index/query/Rewriteable.java index 826c6e71796c6..dd148bf98ea48 100644 --- a/server/src/main/java/org/opensearch/index/query/Rewriteable.java +++ b/server/src/main/java/org/opensearch/index/query/Rewriteable.java @@ -40,6 +40,8 @@ /** * A basic interface for rewriteable classes. + * + * @opensearch.internal */ public interface Rewriteable { diff --git a/server/src/main/java/org/opensearch/index/query/ScriptQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/ScriptQueryBuilder.java index 1d781060dc6bc..b4e6a6d9a9cdd 100644 --- a/server/src/main/java/org/opensearch/index/query/ScriptQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/ScriptQueryBuilder.java @@ -59,6 +59,11 @@ import static org.opensearch.search.SearchService.ALLOW_EXPENSIVE_QUERIES; +/** + * Query builder for script queries + * + * @opensearch.internal + */ public class ScriptQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "script"; diff --git a/server/src/main/java/org/opensearch/index/query/SearchIndexNameMatcher.java b/server/src/main/java/org/opensearch/index/query/SearchIndexNameMatcher.java index 8d4d06d65c412..00758309fc0f0 100644 --- a/server/src/main/java/org/opensearch/index/query/SearchIndexNameMatcher.java +++ b/server/src/main/java/org/opensearch/index/query/SearchIndexNameMatcher.java @@ -42,6 +42,8 @@ /** * A predicate that checks whether an index pattern matches the current search shard target. + * + * @opensearch.internal */ public class SearchIndexNameMatcher implements Predicate { private final String indexName; diff --git a/server/src/main/java/org/opensearch/index/query/SimpleQueryStringBuilder.java b/server/src/main/java/org/opensearch/index/query/SimpleQueryStringBuilder.java index 0de30e42eb4d0..30b9fb35d72ed 100644 --- a/server/src/main/java/org/opensearch/index/query/SimpleQueryStringBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SimpleQueryStringBuilder.java @@ -86,6 +86,7 @@ * {@code fields} - fields to search, defaults to _all if not set, allows * boosting a field with ^n * + * @opensearch.internal */ public class SimpleQueryStringBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/SimpleQueryStringFlag.java b/server/src/main/java/org/opensearch/index/query/SimpleQueryStringFlag.java index d6dc6cc1e4462..500e41dc6f73f 100644 --- a/server/src/main/java/org/opensearch/index/query/SimpleQueryStringFlag.java +++ b/server/src/main/java/org/opensearch/index/query/SimpleQueryStringFlag.java @@ -38,6 +38,8 @@ /** * Flags for the XSimpleQueryString parser + * + * @opensearch.internal */ public enum SimpleQueryStringFlag { ALL(-1), diff --git a/server/src/main/java/org/opensearch/index/query/SpanContainingQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanContainingQueryBuilder.java index 9168f7a29f2dc..12a6cfb237f2f 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanContainingQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanContainingQueryBuilder.java @@ -49,6 +49,8 @@ /** * Builder for {@link org.apache.lucene.queries.spans.SpanContainingQuery}. + * + * @opensearch.internal */ public class SpanContainingQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_containing"; diff --git a/server/src/main/java/org/opensearch/index/query/SpanFirstQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanFirstQueryBuilder.java index e3d6315b5d18c..4754b05d9a74f 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanFirstQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanFirstQueryBuilder.java @@ -47,6 +47,11 @@ import static org.opensearch.index.query.SpanQueryBuilder.SpanQueryBuilderUtil.checkNoBoost; +/** + * Query builder for span_first queries + * + * @opensearch.internal + */ public class SpanFirstQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_first"; diff --git a/server/src/main/java/org/opensearch/index/query/SpanMultiTermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanMultiTermQueryBuilder.java index 9411ba9c59087..b067d974393ef 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanMultiTermQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanMultiTermQueryBuilder.java @@ -56,6 +56,8 @@ /** * Query that allows wrapping a {@link MultiTermQueryBuilder} (one of wildcard, fuzzy, prefix, term, range or regexp query) * as a {@link SpanQueryBuilder} so it can be nested. + * + * @opensearch.internal */ public class SpanMultiTermQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/SpanNearQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanNearQueryBuilder.java index a648eedc9f3b5..ccc0b8f9dbde7 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanNearQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanNearQueryBuilder.java @@ -57,6 +57,8 @@ * Matches spans which are near one another. One can specify slop, the maximum number * of intervening unmatched positions, as well as whether matches are required to be in-order. * The span near query maps to Lucene {@link SpanNearQuery}. + * + * @opensearch.internal */ public class SpanNearQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_near"; diff --git a/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java index c43430e00de98..f55a85f7ccda7 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanNotQueryBuilder.java @@ -47,6 +47,11 @@ import static org.opensearch.index.query.SpanQueryBuilder.SpanQueryBuilderUtil.checkNoBoost; +/** + * Query builder for span_not queries + * + * @opensearch.internal + */ public class SpanNotQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_not"; diff --git a/server/src/main/java/org/opensearch/index/query/SpanOrQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanOrQueryBuilder.java index 0a08f778cf889..c85631bff2061 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanOrQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanOrQueryBuilder.java @@ -52,6 +52,8 @@ /** * Span query that matches the union of its clauses. Maps to {@link SpanOrQuery}. + * + * @opensearch.internal */ public class SpanOrQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_or"; diff --git a/server/src/main/java/org/opensearch/index/query/SpanQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanQueryBuilder.java index ba2adadc7a77c..29aa4cfbcc6ce 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanQueryBuilder.java @@ -37,6 +37,8 @@ /** * Marker interface for a specific type of {@link QueryBuilder} that allows to build span queries. + * + * @opensearch.internal */ public interface SpanQueryBuilder extends QueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/SpanTermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanTermQueryBuilder.java index 02a0f55685ca4..e1fafc358c248 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanTermQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanTermQueryBuilder.java @@ -48,6 +48,8 @@ /** * A Span Query that matches documents containing a term. * @see SpanTermQuery + * + * @opensearch.internal */ public class SpanTermQueryBuilder extends BaseTermQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_term"; diff --git a/server/src/main/java/org/opensearch/index/query/SpanWithinQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/SpanWithinQueryBuilder.java index a8ab2a8831f55..c7eab888e5c2a 100644 --- a/server/src/main/java/org/opensearch/index/query/SpanWithinQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/SpanWithinQueryBuilder.java @@ -49,6 +49,8 @@ /** * Builder for {@link org.apache.lucene.queries.spans.SpanWithinQuery}. + * + * @opensearch.internal */ public class SpanWithinQueryBuilder extends AbstractQueryBuilder implements SpanQueryBuilder { public static final String NAME = "span_within"; diff --git a/server/src/main/java/org/opensearch/index/query/TermQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/TermQueryBuilder.java index a600e8284e395..a611b3c77f595 100644 --- a/server/src/main/java/org/opensearch/index/query/TermQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/TermQueryBuilder.java @@ -50,6 +50,8 @@ /** * A Query that matches documents containing a term. + * + * @opensearch.internal */ public class TermQueryBuilder extends BaseTermQueryBuilder { public static final String NAME = "term"; diff --git a/server/src/main/java/org/opensearch/index/query/TermsQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/TermsQueryBuilder.java index ac29cb2cf5201..28f98f7060395 100644 --- a/server/src/main/java/org/opensearch/index/query/TermsQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/TermsQueryBuilder.java @@ -71,6 +71,8 @@ /** * A filter for a field based on several terms matching on any of them. + * + * @opensearch.internal */ public class TermsQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "terms"; diff --git a/server/src/main/java/org/opensearch/index/query/TermsSetQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/TermsSetQueryBuilder.java index f7dd146f9f019..6bb42f8ff5d39 100644 --- a/server/src/main/java/org/opensearch/index/query/TermsSetQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/TermsSetQueryBuilder.java @@ -62,6 +62,11 @@ import java.util.Map; import java.util.Objects; +/** + * Query builder for terms_set queries + * + * @opensearch.internal + */ public final class TermsSetQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "terms_set"; diff --git a/server/src/main/java/org/opensearch/index/query/VectorGeoPointShapeQueryProcessor.java b/server/src/main/java/org/opensearch/index/query/VectorGeoPointShapeQueryProcessor.java index 08ba3dc1fe8fa..eb7923a5b5212 100644 --- a/server/src/main/java/org/opensearch/index/query/VectorGeoPointShapeQueryProcessor.java +++ b/server/src/main/java/org/opensearch/index/query/VectorGeoPointShapeQueryProcessor.java @@ -59,6 +59,11 @@ import java.util.ArrayList; +/** + * Query processor for lucene 6 LatLonPoint queries + * + * @opensearch.internal + */ public class VectorGeoPointShapeQueryProcessor { public Query geoShapeQuery(Geometry shape, String fieldName, ShapeRelation relation, QueryShardContext context) { diff --git a/server/src/main/java/org/opensearch/index/query/VectorGeoShapeQueryProcessor.java b/server/src/main/java/org/opensearch/index/query/VectorGeoShapeQueryProcessor.java index 16a2968a2e7b2..47766c6c8521e 100644 --- a/server/src/main/java/org/opensearch/index/query/VectorGeoShapeQueryProcessor.java +++ b/server/src/main/java/org/opensearch/index/query/VectorGeoShapeQueryProcessor.java @@ -58,6 +58,11 @@ import java.util.ArrayList; import java.util.List; +/** + * Query processor for Lucene 6 LatLonShape queries + * + * @opensearch.internal + */ public class VectorGeoShapeQueryProcessor { public Query geoShapeQuery(Geometry shape, String fieldName, ShapeRelation relation, QueryShardContext context) { diff --git a/server/src/main/java/org/opensearch/index/query/WildcardQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/WildcardQueryBuilder.java index 9dab290b8bd3e..e8c226303e44d 100644 --- a/server/src/main/java/org/opensearch/index/query/WildcardQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/WildcardQueryBuilder.java @@ -59,6 +59,8 @@ * needs to iterate over many terms. In order to prevent extremely slow WildcardQueries, * a Wildcard term should not start with one of the wildcards {@code *} or * {@code ?}. + * + * @opensearch.internal */ public class WildcardQueryBuilder extends AbstractQueryBuilder implements MultiTermQueryBuilder { public static final String NAME = "wildcard"; diff --git a/server/src/main/java/org/opensearch/index/query/WrapperQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/WrapperQueryBuilder.java index 81c8e14f50912..6933c961fdbcb 100644 --- a/server/src/main/java/org/opensearch/index/query/WrapperQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/WrapperQueryBuilder.java @@ -62,6 +62,8 @@ * bool.must(new TermQueryBuilder("field2","value2")); * * + * + * @opensearch.internal */ public class WrapperQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "wrapper"; diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunction.java b/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunction.java index 02d01ef470b61..5d0e05c1cdf30 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunction.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunction.java @@ -41,6 +41,7 @@ * function or something of the kind. This is used, for example, by * {@link GaussDecayFunctionBuilder}. * + * @opensearch.internal */ public interface DecayFunction { diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionBuilder.java index 0ee61b34cd279..b90462baed612 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionBuilder.java @@ -72,6 +72,11 @@ import java.io.InputStream; import java.util.Objects; +/** + * Foundation builder for a decay function + * + * @opensearch.internal + */ public abstract class DecayFunctionBuilder> extends ScoreFunctionBuilder { protected static final String ORIGIN = "origin"; diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionParser.java b/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionParser.java index c4ae707ba9212..bc1dc79694681 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionParser.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/DecayFunctionParser.java @@ -79,6 +79,8 @@ * {@link DecayFunctionBuilder}, setup a PARSER field with this class, and * register them in {@link SearchModule#registerScoreFunctions} or {@link SearchPlugin#getScoreFunctions} * See {@link GaussDecayFunctionBuilder#PARSER} for an example. + * + * @opensearch.internal */ public final class DecayFunctionParser> implements ScoreFunctionParser { diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/ExponentialDecayFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/ExponentialDecayFunctionBuilder.java index b78e75762fe11..96754466bb0e1 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/ExponentialDecayFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/ExponentialDecayFunctionBuilder.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Foundation builder for an exponential decay + * + * @opensearch.internal + */ public class ExponentialDecayFunctionBuilder extends DecayFunctionBuilder { public static final String NAME = "exp"; public static final ScoreFunctionParser PARSER = new DecayFunctionParser<>( diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/FieldValueFactorFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/FieldValueFactorFunctionBuilder.java index 39f12409267ab..f89032f87afec 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/FieldValueFactorFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/FieldValueFactorFunctionBuilder.java @@ -52,6 +52,8 @@ /** * Builder to construct {@code field_value_factor} functions for a function * score query. + * + * @opensearch.internal */ public class FieldValueFactorFunctionBuilder extends ScoreFunctionBuilder { public static final String NAME = "field_value_factor"; diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/FunctionScoreQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/FunctionScoreQueryBuilder.java index f9484e6c94ea7..9f39b8f74d819 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/FunctionScoreQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/FunctionScoreQueryBuilder.java @@ -66,6 +66,8 @@ /** * A query that uses a filters with a script associated with them to compute the * score. + * + * @opensearch.internal */ public class FunctionScoreQueryBuilder extends AbstractQueryBuilder { public static final String NAME = "function_score"; diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/GaussDecayFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/GaussDecayFunctionBuilder.java index ac6ae33cb4ed0..b3e42292addeb 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/GaussDecayFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/GaussDecayFunctionBuilder.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Foundation builder for a gaussian decay + * + * @opensearch.internal + */ public class GaussDecayFunctionBuilder extends DecayFunctionBuilder { public static final String NAME = "gauss"; public static final ParseField FUNCTION_NAME_FIELD = new ParseField(NAME); diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/LinearDecayFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/LinearDecayFunctionBuilder.java index 03102e45a41ba..b3b948677756a 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/LinearDecayFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/LinearDecayFunctionBuilder.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Foundation builder for a linear decay + * + * @opensearch.internal + */ public class LinearDecayFunctionBuilder extends DecayFunctionBuilder { public static final String NAME = "linear"; public static final ScoreFunctionParser PARSER = new DecayFunctionParser<>(LinearDecayFunctionBuilder::new); diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/RandomScoreFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/RandomScoreFunctionBuilder.java index 26495c93082ae..9e65b1703ba8a 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/RandomScoreFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/RandomScoreFunctionBuilder.java @@ -49,6 +49,8 @@ /** * A function that computes a random score for the matched documents + * + * @opensearch.internal */ public class RandomScoreFunctionBuilder extends ScoreFunctionBuilder { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(RandomScoreFunctionBuilder.class); diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilder.java index 4987f260bc9b4..564a4a9de0f19 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilder.java @@ -45,6 +45,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Foundation builder for a score function + * + * @opensearch.internal + */ public abstract class ScoreFunctionBuilder> implements ToXContentFragment, NamedWriteable { private Float weight; diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilders.java b/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilders.java index 59d02e9381d7e..db35752cd5ee7 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilders.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionBuilders.java @@ -40,6 +40,8 @@ /** * Static method aliases for constructors of known {@link ScoreFunctionBuilder}s. + * + * @opensearch.internal */ public class ScoreFunctionBuilders { diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionParser.java b/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionParser.java index e5720b94e71fa..e4674dea7bdf2 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionParser.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/ScoreFunctionParser.java @@ -38,6 +38,8 @@ /** * Parses XContent into a {@link ScoreFunctionBuilder}. + * + * @opensearch.internal */ @FunctionalInterface public interface ScoreFunctionParser> { diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreFunctionBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreFunctionBuilder.java index 2701e5867edde..15ce6a3423157 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreFunctionBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreFunctionBuilder.java @@ -51,6 +51,8 @@ /** * A function that uses a script to compute or influence the score of documents * that match with the inner query or filter. + * + * @opensearch.internal */ public class ScriptScoreFunctionBuilder extends ScoreFunctionBuilder { public static final String NAME = "script_score"; diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreQueryBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreQueryBuilder.java index e2a1f2fb1f5aa..9605ba424bfb0 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreQueryBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/ScriptScoreQueryBuilder.java @@ -61,6 +61,8 @@ /** * A query that computes a document score based on the provided script + * + * @opensearch.internal */ public class ScriptScoreQueryBuilder extends AbstractQueryBuilder { diff --git a/server/src/main/java/org/opensearch/index/query/functionscore/WeightBuilder.java b/server/src/main/java/org/opensearch/index/query/functionscore/WeightBuilder.java index 333a6a3c6ee1c..71f66b0909b44 100644 --- a/server/src/main/java/org/opensearch/index/query/functionscore/WeightBuilder.java +++ b/server/src/main/java/org/opensearch/index/query/functionscore/WeightBuilder.java @@ -43,6 +43,8 @@ /** * A query that multiplies the weight to the score. + * + * @opensearch.internal */ public class WeightBuilder extends ScoreFunctionBuilder { public static final String NAME = "weight"; diff --git a/server/src/main/java/org/opensearch/index/query/support/NestedScope.java b/server/src/main/java/org/opensearch/index/query/support/NestedScope.java index 150498191dfbe..4a09b11666c18 100644 --- a/server/src/main/java/org/opensearch/index/query/support/NestedScope.java +++ b/server/src/main/java/org/opensearch/index/query/support/NestedScope.java @@ -39,6 +39,8 @@ /** * During query parsing this keeps track of the current nested level. + * + * @opensearch.internal */ public final class NestedScope { diff --git a/server/src/main/java/org/opensearch/index/query/support/QueryParsers.java b/server/src/main/java/org/opensearch/index/query/support/QueryParsers.java index 851b334fc10b4..fd5a846060eaa 100644 --- a/server/src/main/java/org/opensearch/index/query/support/QueryParsers.java +++ b/server/src/main/java/org/opensearch/index/query/support/QueryParsers.java @@ -37,6 +37,11 @@ import org.opensearch.common.ParseField; import org.opensearch.common.xcontent.DeprecationHandler; +/** + * Utility class for Query Parsers + * + * @opensearch.internal + */ public final class QueryParsers { public static final ParseField CONSTANT_SCORE = new ParseField("constant_score"); diff --git a/server/src/main/java/org/opensearch/index/recovery/RecoveryStats.java b/server/src/main/java/org/opensearch/index/recovery/RecoveryStats.java index 4be13f3eacc5e..14d8fa6f70939 100644 --- a/server/src/main/java/org/opensearch/index/recovery/RecoveryStats.java +++ b/server/src/main/java/org/opensearch/index/recovery/RecoveryStats.java @@ -45,6 +45,8 @@ /** * Recovery related statistics, starting at the shard level and allowing aggregation to * indices and node level + * + * @opensearch.internal */ public class RecoveryStats implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/index/refresh/RefreshStats.java b/server/src/main/java/org/opensearch/index/refresh/RefreshStats.java index f673ab8ae03d4..8a54e5105c61e 100644 --- a/server/src/main/java/org/opensearch/index/refresh/RefreshStats.java +++ b/server/src/main/java/org/opensearch/index/refresh/RefreshStats.java @@ -43,6 +43,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Encapsulates stats for index refresh + * + * @opensearch.internal + */ public class RefreshStats implements Writeable, ToXContentFragment { private long total; diff --git a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequest.java b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequest.java index 0de9a50dd1e8d..46883f8b274f2 100644 --- a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequest.java +++ b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequest.java @@ -53,6 +53,11 @@ import static org.opensearch.common.unit.TimeValue.timeValueMillis; import static org.opensearch.common.unit.TimeValue.timeValueMinutes; +/** + * Base class for requesting bulk by scrolls + * + * @opensearch.internal + */ public abstract class AbstractBulkByScrollRequest> extends ActionRequest { public static final int MAX_DOCS_ALL_MATCHES = -1; diff --git a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequestBuilder.java b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequestBuilder.java index bb729a4e8e2cb..c32e31802ac35 100644 --- a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequestBuilder.java +++ b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkByScrollRequestBuilder.java @@ -41,6 +41,11 @@ import org.opensearch.common.unit.TimeValue; import org.opensearch.index.query.QueryBuilder; +/** + * Base builder for bulk by scroll requests + * + * @opensearch.internal + */ public abstract class AbstractBulkByScrollRequestBuilder< Request extends AbstractBulkByScrollRequest, Self extends AbstractBulkByScrollRequestBuilder> extends ActionRequestBuilder { diff --git a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequest.java b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequest.java index 27c655ee11087..f98ca036bd263 100644 --- a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequest.java +++ b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequest.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Base request class for bulk indexing by scroll + * + * @opensearch.internal + */ public abstract class AbstractBulkIndexByScrollRequest> extends AbstractBulkByScrollRequest { /** diff --git a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequestBuilder.java b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequestBuilder.java index f26d54d3e2265..2dda25b52f6be 100644 --- a/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequestBuilder.java +++ b/server/src/main/java/org/opensearch/index/reindex/AbstractBulkIndexByScrollRequestBuilder.java @@ -37,6 +37,11 @@ import org.opensearch.client.OpenSearchClient; import org.opensearch.script.Script; +/** + * Base builder class for bulk index by scrolls + * + * @opensearch.internal + */ public abstract class AbstractBulkIndexByScrollRequestBuilder< Request extends AbstractBulkIndexByScrollRequest, Self extends AbstractBulkIndexByScrollRequestBuilder> extends AbstractBulkByScrollRequestBuilder { diff --git a/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponse.java b/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponse.java index 6a4b55f5877e7..b2b123136baf3 100644 --- a/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponse.java +++ b/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponse.java @@ -62,6 +62,8 @@ /** * Response used for actions that index many documents using a scroll request. + * + * @opensearch.internal */ public class BulkByScrollResponse extends ActionResponse implements ToXContentFragment { private TimeValue took; diff --git a/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponseBuilder.java b/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponseBuilder.java index db8d85ac5c8d9..8d51c27c02dd9 100644 --- a/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponseBuilder.java +++ b/server/src/main/java/org/opensearch/index/reindex/BulkByScrollResponseBuilder.java @@ -44,6 +44,8 @@ /** * Helps build a {@link BulkByScrollResponse}. Used by an instance of {@link ObjectParser} when parsing from XContent. + * + * @opensearch.internal */ class BulkByScrollResponseBuilder extends StatusBuilder { private TimeValue took; diff --git a/server/src/main/java/org/opensearch/index/reindex/BulkByScrollTask.java b/server/src/main/java/org/opensearch/index/reindex/BulkByScrollTask.java index e792adb9a32f9..7751b2d848535 100644 --- a/server/src/main/java/org/opensearch/index/reindex/BulkByScrollTask.java +++ b/server/src/main/java/org/opensearch/index/reindex/BulkByScrollTask.java @@ -82,6 +82,8 @@ * We don't always know if this task will be a leader or worker task when it's created, because if slices is set to "auto" it may * be either depending on the number of shards in the source indices. We figure that out when the request is handled and set it on this * class with {@link #setWorkerCount(int)} or {@link #setWorker(float, Integer)}. + * + * @opensearch.internal */ public class BulkByScrollTask extends CancellableTask { diff --git a/server/src/main/java/org/opensearch/index/reindex/ClientScrollableHitSource.java b/server/src/main/java/org/opensearch/index/reindex/ClientScrollableHitSource.java index 6a78d16d3b385..82008746f06f8 100644 --- a/server/src/main/java/org/opensearch/index/reindex/ClientScrollableHitSource.java +++ b/server/src/main/java/org/opensearch/index/reindex/ClientScrollableHitSource.java @@ -66,6 +66,8 @@ /** * A scrollable source of hits from a {@linkplain Client} instance. + * + * @opensearch.internal */ public class ClientScrollableHitSource extends ScrollableHitSource { private final ParentTaskAssigningClient client; diff --git a/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryAction.java b/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryAction.java index eda40576b7190..5292c793e9c3c 100644 --- a/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryAction.java +++ b/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryAction.java @@ -34,6 +34,11 @@ import org.opensearch.action.ActionType; +/** + * Action type for delete by query + * + * @opensearch.internal + */ public class DeleteByQueryAction extends ActionType { public static final DeleteByQueryAction INSTANCE = new DeleteByQueryAction(); diff --git a/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequest.java b/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequest.java index 4f297b89c0651..bfc9ea00cea38 100644 --- a/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequest.java +++ b/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequest.java @@ -62,6 +62,8 @@ * stored in the transaction logs that might not be supported in the future. *

  • it's results won't be visible until the index is refreshed.
    • * + * + * @opensearch.internal */ public class DeleteByQueryRequest extends AbstractBulkByScrollRequest implements diff --git a/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequestBuilder.java b/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequestBuilder.java index a508536245e9b..bfc0a1b77c580 100644 --- a/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequestBuilder.java +++ b/server/src/main/java/org/opensearch/index/reindex/DeleteByQueryRequestBuilder.java @@ -37,6 +37,11 @@ import org.opensearch.action.search.SearchRequestBuilder; import org.opensearch.client.OpenSearchClient; +/** + * Builder for delete by query + * + * @opensearch.internal + */ public class DeleteByQueryRequestBuilder extends AbstractBulkByScrollRequestBuilder { public DeleteByQueryRequestBuilder(OpenSearchClient client, ActionType action) { diff --git a/server/src/main/java/org/opensearch/index/reindex/LeaderBulkByScrollTaskState.java b/server/src/main/java/org/opensearch/index/reindex/LeaderBulkByScrollTaskState.java index 1edc48c3b0d90..bef696fe18ed4 100644 --- a/server/src/main/java/org/opensearch/index/reindex/LeaderBulkByScrollTaskState.java +++ b/server/src/main/java/org/opensearch/index/reindex/LeaderBulkByScrollTaskState.java @@ -44,6 +44,8 @@ /** * Tracks the state of sliced subtasks and provides unified status information for a sliced BulkByScrollRequest. + * + * @opensearch.internal */ public class LeaderBulkByScrollTaskState { diff --git a/server/src/main/java/org/opensearch/index/reindex/ReindexAction.java b/server/src/main/java/org/opensearch/index/reindex/ReindexAction.java index 6888cd1262579..e4695b34af497 100644 --- a/server/src/main/java/org/opensearch/index/reindex/ReindexAction.java +++ b/server/src/main/java/org/opensearch/index/reindex/ReindexAction.java @@ -34,6 +34,11 @@ import org.opensearch.action.ActionType; +/** + * Action type for reindex requests + * + * @opensearch.internal + */ public class ReindexAction extends ActionType { public static final ReindexAction INSTANCE = new ReindexAction(); public static final String NAME = "indices:data/write/reindex"; diff --git a/server/src/main/java/org/opensearch/index/reindex/ReindexRequest.java b/server/src/main/java/org/opensearch/index/reindex/ReindexRequest.java index 5858b4b8108d2..b444757b85951 100644 --- a/server/src/main/java/org/opensearch/index/reindex/ReindexRequest.java +++ b/server/src/main/java/org/opensearch/index/reindex/ReindexRequest.java @@ -73,6 +73,8 @@ * returning all the subrequests that it will make it tries to return a representative set of subrequests. This is best-effort for a bunch * of reasons, not least of which that scripts are allowed to change the destination request in drastic ways, including changing the index * to which documents are written. + * + * @opensearch.internal */ public class ReindexRequest extends AbstractBulkIndexByScrollRequest implements CompositeIndicesRequest, ToXContentObject { /** diff --git a/server/src/main/java/org/opensearch/index/reindex/ReindexRequestBuilder.java b/server/src/main/java/org/opensearch/index/reindex/ReindexRequestBuilder.java index 291acd1e8ad8d..c59b5885c25be 100644 --- a/server/src/main/java/org/opensearch/index/reindex/ReindexRequestBuilder.java +++ b/server/src/main/java/org/opensearch/index/reindex/ReindexRequestBuilder.java @@ -39,6 +39,11 @@ import org.opensearch.action.search.SearchRequestBuilder; import org.opensearch.client.OpenSearchClient; +/** + * Builder for reindex requests + * + * @opensearch.internal + */ public class ReindexRequestBuilder extends AbstractBulkIndexByScrollRequestBuilder { private final IndexRequestBuilder destination; diff --git a/server/src/main/java/org/opensearch/index/reindex/RejectAwareActionListener.java b/server/src/main/java/org/opensearch/index/reindex/RejectAwareActionListener.java index 1e5f10ce30915..da3afb178300e 100644 --- a/server/src/main/java/org/opensearch/index/reindex/RejectAwareActionListener.java +++ b/server/src/main/java/org/opensearch/index/reindex/RejectAwareActionListener.java @@ -37,6 +37,11 @@ import java.util.function.Consumer; +/** + * Action listener for rejections + * + * @opensearch.internal + */ // public for testing public interface RejectAwareActionListener extends ActionListener { void onRejection(Exception e); diff --git a/server/src/main/java/org/opensearch/index/reindex/RemoteInfo.java b/server/src/main/java/org/opensearch/index/reindex/RemoteInfo.java index 03d0ab072a5a1..6464ce266b1fc 100644 --- a/server/src/main/java/org/opensearch/index/reindex/RemoteInfo.java +++ b/server/src/main/java/org/opensearch/index/reindex/RemoteInfo.java @@ -57,6 +57,11 @@ import static org.opensearch.common.unit.TimeValue.timeValueSeconds; import static org.opensearch.index.query.QueryBuilders.matchAllQuery; +/** + * Encapsulates informatoin for remote resources + * + * @opensearch.internal + */ public class RemoteInfo implements Writeable, ToXContentObject { /** * Default {@link #socketTimeout} for requests that don't have one set. diff --git a/server/src/main/java/org/opensearch/index/reindex/RetryListener.java b/server/src/main/java/org/opensearch/index/reindex/RetryListener.java index a3d469ba66ebc..ad09080cfea2b 100644 --- a/server/src/main/java/org/opensearch/index/reindex/RetryListener.java +++ b/server/src/main/java/org/opensearch/index/reindex/RetryListener.java @@ -42,6 +42,11 @@ import java.util.Iterator; import java.util.function.Consumer; +/** + * Base listener for retries + * + * @opensearch.internal + */ class RetryListener implements RejectAwareActionListener { private final Logger logger; private final Iterator retries; diff --git a/server/src/main/java/org/opensearch/index/reindex/ScrollableHitSource.java b/server/src/main/java/org/opensearch/index/reindex/ScrollableHitSource.java index f0c720e21a73e..a61d53714a9b8 100644 --- a/server/src/main/java/org/opensearch/index/reindex/ScrollableHitSource.java +++ b/server/src/main/java/org/opensearch/index/reindex/ScrollableHitSource.java @@ -66,6 +66,8 @@ * A scrollable source of results. Pumps data out into the passed onResponse consumer. Same data may come out several times in case * of failures during searching (though not yet). Once the onResponse consumer is done, it should call AsyncResponse.isDone(time) to receive * more data (only receives one response at a time). + * + * @opensearch.internal */ public abstract class ScrollableHitSource { private final AtomicReference scrollId = new AtomicReference<>(); diff --git a/server/src/main/java/org/opensearch/index/reindex/SuccessfullyProcessed.java b/server/src/main/java/org/opensearch/index/reindex/SuccessfullyProcessed.java index 94aa5b77f541a..343f5e2a1c52b 100644 --- a/server/src/main/java/org/opensearch/index/reindex/SuccessfullyProcessed.java +++ b/server/src/main/java/org/opensearch/index/reindex/SuccessfullyProcessed.java @@ -35,6 +35,8 @@ /** * Implemented by {@link WorkerBulkByScrollTaskState} and {@link BulkByScrollTask.Status} to consistently implement * {@link #getSuccessfullyProcessed()}. + * + * @opensearch.internal */ public interface SuccessfullyProcessed { /** diff --git a/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryAction.java b/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryAction.java index 8facce990be6f..322a552b310fb 100644 --- a/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryAction.java +++ b/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryAction.java @@ -34,6 +34,11 @@ import org.opensearch.action.ActionType; +/** + * Action type for updating by query + * + * @opensearch.internal + */ public class UpdateByQueryAction extends ActionType { public static final UpdateByQueryAction INSTANCE = new UpdateByQueryAction(); public static final String NAME = "indices:data/write/update/byquery"; diff --git a/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequest.java b/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequest.java index 92bcef8455e63..446065925ef5f 100644 --- a/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequest.java +++ b/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequest.java @@ -49,6 +49,8 @@ * CompositeIndicesRequest but in a misleading way. Rather than returning all the subrequests that it will make it tries to return a * representative set of subrequests. This is best-effort but better than {@linkplain ReindexRequest} because scripts can't change the * destination index and things. + * + * @opensearch.internal */ public class UpdateByQueryRequest extends AbstractBulkIndexByScrollRequest implements diff --git a/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequestBuilder.java b/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequestBuilder.java index f2184167a1eb7..1e4847157b0bb 100644 --- a/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequestBuilder.java +++ b/server/src/main/java/org/opensearch/index/reindex/UpdateByQueryRequestBuilder.java @@ -37,6 +37,11 @@ import org.opensearch.action.search.SearchRequestBuilder; import org.opensearch.client.OpenSearchClient; +/** + * Request builder for updating a document by query + * + * @opensearch.internal + */ public class UpdateByQueryRequestBuilder extends AbstractBulkIndexByScrollRequestBuilder< UpdateByQueryRequest, UpdateByQueryRequestBuilder> { diff --git a/server/src/main/java/org/opensearch/index/reindex/WorkerBulkByScrollTaskState.java b/server/src/main/java/org/opensearch/index/reindex/WorkerBulkByScrollTaskState.java index 2846298e005e7..eefdc4f90dc7b 100644 --- a/server/src/main/java/org/opensearch/index/reindex/WorkerBulkByScrollTaskState.java +++ b/server/src/main/java/org/opensearch/index/reindex/WorkerBulkByScrollTaskState.java @@ -53,6 +53,8 @@ /** * Task behavior for {@link BulkByScrollTask} that does the actual work of querying and indexing + * + * @opensearch.internal */ public class WorkerBulkByScrollTaskState implements SuccessfullyProcessed { diff --git a/server/src/main/java/org/opensearch/index/search/MatchQuery.java b/server/src/main/java/org/opensearch/index/search/MatchQuery.java index 485715c430b3f..950d63d657075 100644 --- a/server/src/main/java/org/opensearch/index/search/MatchQuery.java +++ b/server/src/main/java/org/opensearch/index/search/MatchQuery.java @@ -82,6 +82,11 @@ import static org.opensearch.common.lucene.search.Queries.newLenientFieldQuery; import static org.opensearch.common.lucene.search.Queries.newUnmappedFieldQuery; +/** + * Foundation match query + * + * @opensearch.internal + */ public class MatchQuery { public enum Type implements Writeable { diff --git a/server/src/main/java/org/opensearch/index/search/MultiMatchQuery.java b/server/src/main/java/org/opensearch/index/search/MultiMatchQuery.java index f924c698c0f22..6dd2a33f96bb4 100644 --- a/server/src/main/java/org/opensearch/index/search/MultiMatchQuery.java +++ b/server/src/main/java/org/opensearch/index/search/MultiMatchQuery.java @@ -58,6 +58,11 @@ import static org.opensearch.common.lucene.search.Queries.newLenientFieldQuery; +/** + * Foundation multi match query + * + * @opensearch.internal + */ public class MultiMatchQuery extends MatchQuery { private Float groupTieBreaker = null; diff --git a/server/src/main/java/org/opensearch/index/search/NestedHelper.java b/server/src/main/java/org/opensearch/index/search/NestedHelper.java index 487dc2bddde6b..ae91f66c5aebd 100644 --- a/server/src/main/java/org/opensearch/index/search/NestedHelper.java +++ b/server/src/main/java/org/opensearch/index/search/NestedHelper.java @@ -49,7 +49,10 @@ import org.opensearch.index.mapper.ObjectMapper; /** Utility class to filter parent and children clauses when building nested - * queries. */ + * queries. + * + * @opensearch.internal + */ public final class NestedHelper { private final MapperService mapperService; diff --git a/server/src/main/java/org/opensearch/index/search/OpenSearchToParentBlockJoinQuery.java b/server/src/main/java/org/opensearch/index/search/OpenSearchToParentBlockJoinQuery.java index 66f66be43b0ca..770301629d964 100644 --- a/server/src/main/java/org/opensearch/index/search/OpenSearchToParentBlockJoinQuery.java +++ b/server/src/main/java/org/opensearch/index/search/OpenSearchToParentBlockJoinQuery.java @@ -45,7 +45,11 @@ import java.io.IOException; import java.util.Objects; -/** A {@link ToParentBlockJoinQuery} that allows to retrieve its nested path. */ +/** + * A {@link ToParentBlockJoinQuery} that allows to retrieve its nested path. + * + * @opensearch.internal + */ public final class OpenSearchToParentBlockJoinQuery extends Query { private final ToParentBlockJoinQuery query; diff --git a/server/src/main/java/org/opensearch/index/search/QueryParserHelper.java b/server/src/main/java/org/opensearch/index/search/QueryParserHelper.java index 68c61bd9acc54..5e9839385ce20 100644 --- a/server/src/main/java/org/opensearch/index/search/QueryParserHelper.java +++ b/server/src/main/java/org/opensearch/index/search/QueryParserHelper.java @@ -48,6 +48,8 @@ /** * Helpers to extract and expand field names and boosts + * + * @opensearch.internal */ public final class QueryParserHelper { private QueryParserHelper() {} diff --git a/server/src/main/java/org/opensearch/index/search/QueryStringQueryParser.java b/server/src/main/java/org/opensearch/index/search/QueryStringQueryParser.java index 980a42163c9c9..cdb7464ff250a 100644 --- a/server/src/main/java/org/opensearch/index/search/QueryStringQueryParser.java +++ b/server/src/main/java/org/opensearch/index/search/QueryStringQueryParser.java @@ -90,6 +90,8 @@ * queries based on the mapping information. * This class uses {@link MultiMatchQuery} to build the text query around operators and {@link XQueryParser} * to assemble the result logically. + * + * @opensearch.internal */ public class QueryStringQueryParser extends XQueryParser { private static final String EXISTS_FIELD = "_exists_"; diff --git a/server/src/main/java/org/opensearch/index/search/SimpleQueryStringQueryParser.java b/server/src/main/java/org/opensearch/index/search/SimpleQueryStringQueryParser.java index f4f68634d0df5..f57af7b3370bf 100644 --- a/server/src/main/java/org/opensearch/index/search/SimpleQueryStringQueryParser.java +++ b/server/src/main/java/org/opensearch/index/search/SimpleQueryStringQueryParser.java @@ -66,6 +66,8 @@ /** * Wrapper class for Lucene's SimpleQueryStringQueryParser that allows us to redefine * different types of queries. + * + * @opensearch.internal */ public class SimpleQueryStringQueryParser extends SimpleQueryParser { diff --git a/server/src/main/java/org/opensearch/index/search/stats/SearchStats.java b/server/src/main/java/org/opensearch/index/search/stats/SearchStats.java index d55c2924eccf6..34584d5cb6f89 100644 --- a/server/src/main/java/org/opensearch/index/search/stats/SearchStats.java +++ b/server/src/main/java/org/opensearch/index/search/stats/SearchStats.java @@ -47,6 +47,11 @@ import java.util.HashMap; import java.util.Map; +/** + * Encapsulates stats for search time + * + * @opensearch.internal + */ public class SearchStats implements Writeable, ToXContentFragment { public static class Stats implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/index/search/stats/ShardSearchStats.java b/server/src/main/java/org/opensearch/index/search/stats/ShardSearchStats.java index 917ea99432da7..93373e57a1081 100644 --- a/server/src/main/java/org/opensearch/index/search/stats/ShardSearchStats.java +++ b/server/src/main/java/org/opensearch/index/search/stats/ShardSearchStats.java @@ -48,6 +48,11 @@ import static java.util.Collections.emptyMap; +/** + * Shard level search stats + * + * @opensearch.internal + */ public final class ShardSearchStats implements SearchOperationListener { private final StatsHolder totalStats = new StatsHolder(); diff --git a/server/src/main/java/org/opensearch/index/seqno/CountedBitSet.java b/server/src/main/java/org/opensearch/index/seqno/CountedBitSet.java index 1bccfc4047fad..2f40b0bc8b0c6 100644 --- a/server/src/main/java/org/opensearch/index/seqno/CountedBitSet.java +++ b/server/src/main/java/org/opensearch/index/seqno/CountedBitSet.java @@ -39,6 +39,8 @@ * A {@link CountedBitSet} wraps a {@link FixedBitSet} but automatically releases the internal bitset * when all bits are set to reduce memory usage. This structure can work well for sequence numbers as * these numbers are likely to form contiguous ranges (eg. filling all bits). + * + * @opensearch.internal */ public final class CountedBitSet { static final long BASE_RAM_BYTES_USED = RamUsageEstimator.shallowSizeOfInstance(CountedBitSet.class); diff --git a/server/src/main/java/org/opensearch/index/seqno/GlobalCheckpointSyncAction.java b/server/src/main/java/org/opensearch/index/seqno/GlobalCheckpointSyncAction.java index a46a0c0d70a4d..83ee51b0d2654 100644 --- a/server/src/main/java/org/opensearch/index/seqno/GlobalCheckpointSyncAction.java +++ b/server/src/main/java/org/opensearch/index/seqno/GlobalCheckpointSyncAction.java @@ -60,6 +60,8 @@ * Background global checkpoint sync action initiated when a shard goes inactive. This is needed because while we send the global checkpoint * on every replication operation, after the last operation completes the global checkpoint could advance but without a follow-up operation * the global checkpoint will never be synced to the replicas. + * + * @opensearch.internal */ public class GlobalCheckpointSyncAction extends TransportReplicationAction< GlobalCheckpointSyncAction.Request, diff --git a/server/src/main/java/org/opensearch/index/seqno/LocalCheckpointTracker.java b/server/src/main/java/org/opensearch/index/seqno/LocalCheckpointTracker.java index 7aab597f8816c..058d3043d21e0 100644 --- a/server/src/main/java/org/opensearch/index/seqno/LocalCheckpointTracker.java +++ b/server/src/main/java/org/opensearch/index/seqno/LocalCheckpointTracker.java @@ -40,6 +40,8 @@ /** * This class generates sequences numbers and keeps track of the so-called "local checkpoint" which is the highest number for which all * previous sequence numbers have been processed (inclusive). + * + * @opensearch.internal */ public class LocalCheckpointTracker { diff --git a/server/src/main/java/org/opensearch/index/seqno/ReplicationTracker.java b/server/src/main/java/org/opensearch/index/seqno/ReplicationTracker.java index 99509ad5d1da9..ac611a4af4318 100644 --- a/server/src/main/java/org/opensearch/index/seqno/ReplicationTracker.java +++ b/server/src/main/java/org/opensearch/index/seqno/ReplicationTracker.java @@ -90,6 +90,8 @@ * shards that are taken into account for the global checkpoint calculation are called the "in-sync shards". *

    * The global checkpoint is maintained by the primary shard and is replicated to all the replicas (via {@link GlobalCheckpointSyncAction}). + * + * @opensearch.internal */ public class ReplicationTracker extends AbstractIndexShardComponent implements LongSupplier { diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLease.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLease.java index f9ab4c4e3ff1f..63151ceb647de 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLease.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLease.java @@ -49,6 +49,8 @@ * that all operations with sequence number at least that retaining sequence number will be retained during merge operations (which could * otherwise merge away operations that have been soft deleted). Each retention lease contains a unique identifier, the retaining sequence * number, the timestamp of when the lease was created or renewed, and the source of the retention lease (e.g., "ccr"). + * + * @opensearch.internal */ public final class RetentionLease implements ToXContentObject, Writeable { diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseActions.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseActions.java index 37c32e1c4409c..3827666a5678c 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseActions.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseActions.java @@ -64,6 +64,8 @@ * responded with success. Additionally, note the use of * {@link TransportSingleShardAction#asyncShardOperation(SingleShardRequest, ShardId, ActionListener)} to handle the case when acquiring * permits goes asynchronous because acquiring permits is blocked + * + * @opensearch.internal */ public class RetentionLeaseActions { diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseAlreadyExistsException.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseAlreadyExistsException.java index 20761621d6c16..f394b4b69affe 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseAlreadyExistsException.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseAlreadyExistsException.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Exception thrown if a retention lease already exists + * + * @opensearch.internal + */ public class RetentionLeaseAlreadyExistsException extends ResourceAlreadyExistsException { public RetentionLeaseAlreadyExistsException(final String id) { diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseBackgroundSyncAction.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseBackgroundSyncAction.java index 014ffedb81e3f..891b55f0e8391 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseBackgroundSyncAction.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseBackgroundSyncAction.java @@ -73,6 +73,8 @@ * that if a replica misses a background retention lease sync then that shard will not be marked as stale. We have some tolerance for a * shard copy missing renewals of retention leases since the background sync interval is much smaller than the expected lifetime of * retention leases. + * + * @opensearch.internal */ public class RetentionLeaseBackgroundSyncAction extends TransportReplicationAction< RetentionLeaseBackgroundSyncAction.Request, diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseInvalidRetainingSeqNoException.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseInvalidRetainingSeqNoException.java index 5231c7260a292..b532846f57ac4 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseInvalidRetainingSeqNoException.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseInvalidRetainingSeqNoException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown when an invalid sequence number is retained + * + * @opensearch.internal + */ public class RetentionLeaseInvalidRetainingSeqNoException extends OpenSearchException { RetentionLeaseInvalidRetainingSeqNoException( diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseNotFoundException.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseNotFoundException.java index 1f77206bf998c..524778d0f9414 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseNotFoundException.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseNotFoundException.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Exception thrown when a retention lease is not found + * + * @opensearch.internal + */ public class RetentionLeaseNotFoundException extends ResourceNotFoundException { public RetentionLeaseNotFoundException(final String id) { diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseStats.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseStats.java index 77749915958be..a9dbf2288aea4 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseStats.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseStats.java @@ -43,6 +43,8 @@ /** * Represents retention lease stats. + * + * @opensearch.internal */ public final class RetentionLeaseStats implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncAction.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncAction.java index 55bd01df0979a..a6aebeb21a76a 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncAction.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncAction.java @@ -74,6 +74,8 @@ /** * Write action responsible for syncing retention leases to replicas. This action is deliberately a write action so that if a replica misses * a retention lease sync then that shard will be marked as stale. + * + * @opensearch.internal */ public class RetentionLeaseSyncAction extends TransportWriteAction< RetentionLeaseSyncAction.Request, diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncer.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncer.java index a8f48b0d431a5..25a768868f5d5 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncer.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeaseSyncer.java @@ -39,6 +39,11 @@ import java.util.Objects; +/** + * Syncs retention leases + * + * @opensearch.internal + */ public class RetentionLeaseSyncer { private final SyncAction syncAction; private final BackgroundSyncAction backgroundSyncAction; diff --git a/server/src/main/java/org/opensearch/index/seqno/RetentionLeases.java b/server/src/main/java/org/opensearch/index/seqno/RetentionLeases.java index e5fef4dcffc5a..c879e38510dde 100644 --- a/server/src/main/java/org/opensearch/index/seqno/RetentionLeases.java +++ b/server/src/main/java/org/opensearch/index/seqno/RetentionLeases.java @@ -55,6 +55,8 @@ /** * Represents a versioned collection of retention leases. We version the collection of retention leases to ensure that sync requests that * arrive out of order on the replica, using the version to ensure that older sync requests are rejected. + * + * @opensearch.internal */ public class RetentionLeases implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/index/seqno/SeqNoStats.java b/server/src/main/java/org/opensearch/index/seqno/SeqNoStats.java index 0f26377568e17..58c69501c3608 100644 --- a/server/src/main/java/org/opensearch/index/seqno/SeqNoStats.java +++ b/server/src/main/java/org/opensearch/index/seqno/SeqNoStats.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Sequence number statistics + * + * @opensearch.internal + */ public class SeqNoStats implements ToXContentFragment, Writeable { private static final String SEQ_NO = "seq_no"; diff --git a/server/src/main/java/org/opensearch/index/seqno/SequenceNumbers.java b/server/src/main/java/org/opensearch/index/seqno/SequenceNumbers.java index 3da32efe4d027..f8639595d9195 100644 --- a/server/src/main/java/org/opensearch/index/seqno/SequenceNumbers.java +++ b/server/src/main/java/org/opensearch/index/seqno/SequenceNumbers.java @@ -36,6 +36,8 @@ /** * A utility class for handling sequence numbers. + * + * @opensearch.internal */ public class SequenceNumbers { diff --git a/server/src/main/java/org/opensearch/index/shard/AbstractIndexShardComponent.java b/server/src/main/java/org/opensearch/index/shard/AbstractIndexShardComponent.java index 24f0f7aa7b730..2832c17ddc11a 100644 --- a/server/src/main/java/org/opensearch/index/shard/AbstractIndexShardComponent.java +++ b/server/src/main/java/org/opensearch/index/shard/AbstractIndexShardComponent.java @@ -36,6 +36,11 @@ import org.opensearch.common.logging.Loggers; import org.opensearch.index.IndexSettings; +/** + * Base index shard class + * + * @opensearch.internal + */ public abstract class AbstractIndexShardComponent implements IndexShardComponent { protected final Logger logger; diff --git a/server/src/main/java/org/opensearch/index/shard/DocsStats.java b/server/src/main/java/org/opensearch/index/shard/DocsStats.java index e9d41ceff09e8..952f94d26e1ef 100644 --- a/server/src/main/java/org/opensearch/index/shard/DocsStats.java +++ b/server/src/main/java/org/opensearch/index/shard/DocsStats.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Document statistics + * + * @opensearch.internal + */ public class DocsStats implements Writeable, ToXContentFragment { private long count = 0; diff --git a/server/src/main/java/org/opensearch/index/shard/GlobalCheckpointListeners.java b/server/src/main/java/org/opensearch/index/shard/GlobalCheckpointListeners.java index 3c8ed8ea7492a..e26f2ccca4fd1 100644 --- a/server/src/main/java/org/opensearch/index/shard/GlobalCheckpointListeners.java +++ b/server/src/main/java/org/opensearch/index/shard/GlobalCheckpointListeners.java @@ -58,6 +58,8 @@ /** * Represents a collection of global checkpoint listeners. This collection can be added to, and all listeners present at the time of an * update will be notified together. All listeners will be notified when the shard is closed. + * + * @opensearch.internal */ public class GlobalCheckpointListeners implements Closeable { diff --git a/server/src/main/java/org/opensearch/index/shard/IllegalIndexShardStateException.java b/server/src/main/java/org/opensearch/index/shard/IllegalIndexShardStateException.java index a6cd831291e37..bc9bc4a5a61fd 100644 --- a/server/src/main/java/org/opensearch/index/shard/IllegalIndexShardStateException.java +++ b/server/src/main/java/org/opensearch/index/shard/IllegalIndexShardStateException.java @@ -39,6 +39,11 @@ import java.io.IOException; +/** + * Exception thrown when an index shard is in an illegal state + * + * @opensearch.internal + */ public class IllegalIndexShardStateException extends OpenSearchException { private final IndexShardState currentState; diff --git a/server/src/main/java/org/opensearch/index/shard/IndexEventListener.java b/server/src/main/java/org/opensearch/index/shard/IndexEventListener.java index c07798202144b..600bbc0af4cbc 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexEventListener.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexEventListener.java @@ -49,6 +49,8 @@ * local state via their arguments. Yet, if an instance is shared across indices they might be called concurrently and should not * modify local state without sufficient synchronization. *

    + * + * @opensearch.internal */ public interface IndexEventListener { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexSettingProvider.java b/server/src/main/java/org/opensearch/index/shard/IndexSettingProvider.java index 7d1e77214640b..441a9a6413ffc 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexSettingProvider.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexSettingProvider.java @@ -37,6 +37,8 @@ /** * An {@link IndexSettingProvider} is a provider for index level settings that can be set * explicitly as a default value (so they show up as "set" for newly created indices) + * + * @opensearch.internal */ public interface IndexSettingProvider { /** diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShard.java b/server/src/main/java/org/opensearch/index/shard/IndexShard.java index f02b7047899ce..b11148a9a2ef1 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShard.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShard.java @@ -199,6 +199,11 @@ import static org.opensearch.index.seqno.RetentionLeaseActions.RETAIN_ALL; import static org.opensearch.index.seqno.SequenceNumbers.UNASSIGNED_SEQ_NO; +/** + * An OpenSearch index shard + * + * @opensearch.internal + */ public class IndexShard extends AbstractIndexShardComponent implements IndicesClusterStateService.Shard { private final ThreadPool threadPool; diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardClosedException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardClosedException.java index a7f58ddfb84d0..e4452a377c167 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardClosedException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardClosedException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if trying to operate on a closed Index Shard + * + * @opensearch.internal + */ public class IndexShardClosedException extends IllegalIndexShardStateException { public IndexShardClosedException(ShardId shardId) { super(shardId, IndexShardState.CLOSED, "Closed"); diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardComponent.java b/server/src/main/java/org/opensearch/index/shard/IndexShardComponent.java index 9f8ae26ca3110..66e0d74c47a72 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardComponent.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardComponent.java @@ -34,6 +34,11 @@ import org.opensearch.index.IndexSettings; +/** + * Base interface for an IndexShard + * + * @opensearch.internal + */ public interface IndexShardComponent { ShardId shardId(); diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardNotRecoveringException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardNotRecoveringException.java index 9245119f9bf23..f75e1f2ac7bc5 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardNotRecoveringException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardNotRecoveringException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if an index shard is not recovering + * + * @opensearch.internal + */ public class IndexShardNotRecoveringException extends IllegalIndexShardStateException { public IndexShardNotRecoveringException(ShardId shardId, IndexShardState currentState) { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardNotStartedException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardNotStartedException.java index b4be8cc08a6b6..cf33d30a339d5 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardNotStartedException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardNotStartedException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown when trying to operate on an Index Shard that hasn't been started + * + * @opensearch.internal + */ public class IndexShardNotStartedException extends IllegalIndexShardStateException { public IndexShardNotStartedException(ShardId shardId, IndexShardState currentState) { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardOperationPermits.java b/server/src/main/java/org/opensearch/index/shard/IndexShardOperationPermits.java index 9474a7dc99bb9..3e788b55c6f32 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardOperationPermits.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardOperationPermits.java @@ -64,6 +64,8 @@ * between terms) we immediately delay all operations to a queue, obtain all available permits, and wait for outstanding operations to drain * and return their permits. Delayed operations will acquire permits and be completed after the operation that blocked all operations has * completed. + * + * @opensearch.internal */ final class IndexShardOperationPermits implements Closeable { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveringException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveringException.java index 7a71dcdf207ca..11e93c978c7d1 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveringException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveringException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown when there is an error recovering an Index Shard + * + * @opensearch.internal + */ public class IndexShardRecoveringException extends IllegalIndexShardStateException { public IndexShardRecoveringException(ShardId shardId) { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveryException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveryException.java index 1c0d51828c6dd..a4cf6164bae5d 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveryException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardRecoveryException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown when there is an error on recovery of Index Shard + * + * @opensearch.internal + */ public class IndexShardRecoveryException extends OpenSearchException { public IndexShardRecoveryException(ShardId shardId, String msg, Throwable cause) { super(msg, cause); diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardRelocatedException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardRelocatedException.java index fbe0306bbc006..3d63dba938d5c 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardRelocatedException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardRelocatedException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if there is an error relocating an index shard + * + * @opensearch.internal + */ public class IndexShardRelocatedException extends IllegalIndexShardStateException { public IndexShardRelocatedException(ShardId shardId) { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardStartedException.java b/server/src/main/java/org/opensearch/index/shard/IndexShardStartedException.java index 3582341b92a55..fd7985a32bd58 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardStartedException.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardStartedException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if there is an error starting an index shard + * + * @opensearch.internal + */ public class IndexShardStartedException extends IllegalIndexShardStateException { public IndexShardStartedException(ShardId shardId) { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexShardState.java b/server/src/main/java/org/opensearch/index/shard/IndexShardState.java index 526dcdad87063..5a0808ece96d5 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexShardState.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexShardState.java @@ -32,6 +32,9 @@ package org.opensearch.index.shard; +/** + * Index Shard States + */ public enum IndexShardState { CREATED((byte) 0), RECOVERING((byte) 1), diff --git a/server/src/main/java/org/opensearch/index/shard/IndexingOperationListener.java b/server/src/main/java/org/opensearch/index/shard/IndexingOperationListener.java index aff44203cca22..ed6e9f82ad064 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexingOperationListener.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexingOperationListener.java @@ -39,6 +39,8 @@ /** * An indexing listener for indexing, delete, events. + * + * @opensearch.internal */ public interface IndexingOperationListener { diff --git a/server/src/main/java/org/opensearch/index/shard/IndexingStats.java b/server/src/main/java/org/opensearch/index/shard/IndexingStats.java index bdc5373e0b9b3..c57be2b2b689c 100644 --- a/server/src/main/java/org/opensearch/index/shard/IndexingStats.java +++ b/server/src/main/java/org/opensearch/index/shard/IndexingStats.java @@ -45,6 +45,11 @@ import java.io.IOException; import java.util.Map; +/** + * Tracks indexing statistics + * + * @opensearch.internal + */ public class IndexingStats implements Writeable, ToXContentFragment { public static class Stats implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/index/shard/InternalIndexingStats.java b/server/src/main/java/org/opensearch/index/shard/InternalIndexingStats.java index 76d64ab918163..25500ceafb2ef 100644 --- a/server/src/main/java/org/opensearch/index/shard/InternalIndexingStats.java +++ b/server/src/main/java/org/opensearch/index/shard/InternalIndexingStats.java @@ -41,6 +41,8 @@ /** * Internal class that maintains relevant indexing statistics / metrics. * @see IndexShard + * + * @opensearch.internal */ final class InternalIndexingStats implements IndexingOperationListener { private final StatsHolder totalStats = new StatsHolder(); diff --git a/server/src/main/java/org/opensearch/index/shard/LocalShardSnapshot.java b/server/src/main/java/org/opensearch/index/shard/LocalShardSnapshot.java index 98556db3ae138..dc02cc054118c 100644 --- a/server/src/main/java/org/opensearch/index/shard/LocalShardSnapshot.java +++ b/server/src/main/java/org/opensearch/index/shard/LocalShardSnapshot.java @@ -51,6 +51,11 @@ import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; +/** + * A shard snapshot stored locally + * + * @opensearch.internal + */ final class LocalShardSnapshot implements Closeable { private final IndexShard shard; private final Store store; diff --git a/server/src/main/java/org/opensearch/index/shard/OpenSearchMergePolicy.java b/server/src/main/java/org/opensearch/index/shard/OpenSearchMergePolicy.java index 28ae3f0b30679..258a283c63476 100644 --- a/server/src/main/java/org/opensearch/index/shard/OpenSearchMergePolicy.java +++ b/server/src/main/java/org/opensearch/index/shard/OpenSearchMergePolicy.java @@ -56,6 +56,8 @@ *

    * For now, this {@link MergePolicy} takes care of moving versions that used to * be stored as payloads to numeric doc values. + * + * @opensearch.internal */ public final class OpenSearchMergePolicy extends FilterMergePolicy { diff --git a/server/src/main/java/org/opensearch/index/shard/PrimaryReplicaSyncer.java b/server/src/main/java/org/opensearch/index/shard/PrimaryReplicaSyncer.java index 726d2925177fa..463c9b7ca4af2 100644 --- a/server/src/main/java/org/opensearch/index/shard/PrimaryReplicaSyncer.java +++ b/server/src/main/java/org/opensearch/index/shard/PrimaryReplicaSyncer.java @@ -65,6 +65,11 @@ import static java.util.Objects.requireNonNull; +/** + * Syncer for Primary replica + * + * @opensearch.internal + */ public class PrimaryReplicaSyncer { private static final Logger logger = LogManager.getLogger(PrimaryReplicaSyncer.class); diff --git a/server/src/main/java/org/opensearch/index/shard/RefreshListeners.java b/server/src/main/java/org/opensearch/index/shard/RefreshListeners.java index 570b882e1fcab..7dbbcbb2d7d20 100644 --- a/server/src/main/java/org/opensearch/index/shard/RefreshListeners.java +++ b/server/src/main/java/org/opensearch/index/shard/RefreshListeners.java @@ -56,6 +56,8 @@ * {@link IndexShard} but kept here so it can be tested without standing up the entire thing. * * When {@link Closeable#close()}d it will no longer accept listeners and flush any existing listeners. + * + * @opensearch.internal */ public final class RefreshListeners implements ReferenceManager.RefreshListener, Closeable { private final IntSupplier getMaxRefreshListeners; diff --git a/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedLuceneSegmentsAction.java b/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedLuceneSegmentsAction.java index 621f1fcec28f2..93ef2c4abf09d 100644 --- a/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedLuceneSegmentsAction.java +++ b/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedLuceneSegmentsAction.java @@ -43,6 +43,8 @@ /** * Removes corrupted Lucene index segments + * + * @opensearch.internal */ public class RemoveCorruptedLuceneSegmentsAction { diff --git a/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedShardDataCommand.java b/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedShardDataCommand.java index a6ecc803affbb..feceb017a3663 100644 --- a/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedShardDataCommand.java +++ b/server/src/main/java/org/opensearch/index/shard/RemoveCorruptedShardDataCommand.java @@ -84,6 +84,11 @@ import java.util.Objects; import java.util.stream.StreamSupport; +/** + * Command for removing a corruped shard + * + * @opensearch.internal + */ public class RemoveCorruptedShardDataCommand extends OpenSearchNodeCommand { private static final Logger logger = LogManager.getLogger(RemoveCorruptedShardDataCommand.class); diff --git a/server/src/main/java/org/opensearch/index/shard/ReplicationGroup.java b/server/src/main/java/org/opensearch/index/shard/ReplicationGroup.java index fc52d09361281..6d19e9f500411 100644 --- a/server/src/main/java/org/opensearch/index/shard/ReplicationGroup.java +++ b/server/src/main/java/org/opensearch/index/shard/ReplicationGroup.java @@ -42,6 +42,8 @@ /** * Replication group for a shard. Used by a primary shard to coordinate replication and recoveries. + * + * @opensearch.internal */ public class ReplicationGroup { private final IndexShardRoutingTable routingTable; diff --git a/server/src/main/java/org/opensearch/index/shard/SearchOperationListener.java b/server/src/main/java/org/opensearch/index/shard/SearchOperationListener.java index da4b3a141dfc5..d3177055a5bd8 100644 --- a/server/src/main/java/org/opensearch/index/shard/SearchOperationListener.java +++ b/server/src/main/java/org/opensearch/index/shard/SearchOperationListener.java @@ -43,6 +43,8 @@ /** * An listener for search, fetch and context events. + * + * @opensearch.internal */ public interface SearchOperationListener { diff --git a/server/src/main/java/org/opensearch/index/shard/ShardId.java b/server/src/main/java/org/opensearch/index/shard/ShardId.java index a4ff927c5a5dc..d44e4140fd095 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardId.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardId.java @@ -44,6 +44,8 @@ /** * Allows for shard level components to be injected with the shard id. + * + * @opensearch.internal */ public class ShardId implements Comparable, ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/index/shard/ShardNotFoundException.java b/server/src/main/java/org/opensearch/index/shard/ShardNotFoundException.java index 8346b841007d9..c97f392f54a5a 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardNotFoundException.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardNotFoundException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if a shard is not found + * + * @opensearch.internal + */ public class ShardNotFoundException extends ResourceNotFoundException { public ShardNotFoundException(ShardId shardId) { this(shardId, null); diff --git a/server/src/main/java/org/opensearch/index/shard/ShardNotInPrimaryModeException.java b/server/src/main/java/org/opensearch/index/shard/ShardNotInPrimaryModeException.java index a82f1ba5c77d0..cb03424e027e4 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardNotInPrimaryModeException.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardNotInPrimaryModeException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if a shard is not in primary mode + * + * @opensearch.internal + */ public class ShardNotInPrimaryModeException extends IllegalIndexShardStateException { public ShardNotInPrimaryModeException(final ShardId shardId, final IndexShardState currentState) { diff --git a/server/src/main/java/org/opensearch/index/shard/ShardPath.java b/server/src/main/java/org/opensearch/index/shard/ShardPath.java index 39f86ea362bb1..9960326e914e4 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardPath.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardPath.java @@ -50,6 +50,11 @@ import java.util.Map; import java.util.Objects; +/** + * Path for a shard + * + * @opensearch.internal + */ public final class ShardPath { public static final String INDEX_FOLDER_NAME = "index"; public static final String TRANSLOG_FOLDER_NAME = "translog"; diff --git a/server/src/main/java/org/opensearch/index/shard/ShardSplittingQuery.java b/server/src/main/java/org/opensearch/index/shard/ShardSplittingQuery.java index 16d76ece840a2..5f3297fa08b08 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardSplittingQuery.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardSplittingQuery.java @@ -72,6 +72,8 @@ * A query that selects all docs that do NOT belong in the current shards this query is executed on. * It can be used to split a shard into N shards marking every document that doesn't belong into the shard * as deleted. See {@link org.apache.lucene.index.IndexWriter#deleteDocuments(Query...)} + * + * @opensearch.internal */ final class ShardSplittingQuery extends Query { private final IndexMetadata indexMetadata; diff --git a/server/src/main/java/org/opensearch/index/shard/ShardStateMetadata.java b/server/src/main/java/org/opensearch/index/shard/ShardStateMetadata.java index 194c1e58277a8..9cd9149cda913 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardStateMetadata.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardStateMetadata.java @@ -45,6 +45,11 @@ import java.io.OutputStream; import java.util.Objects; +/** + * Metadata string a shard state + * + * @opensearch.internal + */ public final class ShardStateMetadata { private static final String SHARD_STATE_FILE_PREFIX = "state-"; diff --git a/server/src/main/java/org/opensearch/index/shard/ShardToolCli.java b/server/src/main/java/org/opensearch/index/shard/ShardToolCli.java index 0234e85fbf0db..1b4eb5a3f8c39 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardToolCli.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardToolCli.java @@ -36,6 +36,8 @@ /** * Class encapsulating and dispatching commands from the {@code opensearch-shard} command line tool + * + * @opensearch.internal */ public class ShardToolCli extends LoggingAwareMultiCommand { diff --git a/server/src/main/java/org/opensearch/index/shard/ShardUtils.java b/server/src/main/java/org/opensearch/index/shard/ShardUtils.java index a9cbd2c3f23f9..3d51fa6a05357 100644 --- a/server/src/main/java/org/opensearch/index/shard/ShardUtils.java +++ b/server/src/main/java/org/opensearch/index/shard/ShardUtils.java @@ -38,6 +38,11 @@ import org.opensearch.common.lucene.index.OpenSearchDirectoryReader; import org.opensearch.common.lucene.index.OpenSearchLeafReader; +/** + * Utility class for shard operations + * + * @opensearch.internal + */ public final class ShardUtils { private ShardUtils() {} diff --git a/server/src/main/java/org/opensearch/index/shard/StoreRecovery.java b/server/src/main/java/org/opensearch/index/shard/StoreRecovery.java index 6eb7a29984e1c..7ed424e9623eb 100644 --- a/server/src/main/java/org/opensearch/index/shard/StoreRecovery.java +++ b/server/src/main/java/org/opensearch/index/shard/StoreRecovery.java @@ -79,6 +79,8 @@ /** * This package private utility class encapsulates the logic to recover an index shard from either an existing index on * disk or from a snapshot in a repository. + * + * @opensearch.internal */ final class StoreRecovery { diff --git a/server/src/main/java/org/opensearch/index/similarity/NonNegativeScoresSimilarity.java b/server/src/main/java/org/opensearch/index/similarity/NonNegativeScoresSimilarity.java index 420f81b755987..9d8be5703a6b7 100644 --- a/server/src/main/java/org/opensearch/index/similarity/NonNegativeScoresSimilarity.java +++ b/server/src/main/java/org/opensearch/index/similarity/NonNegativeScoresSimilarity.java @@ -42,6 +42,8 @@ * A {@link Similarity} that rejects negative scores. This class exists so that users get * an error instead of silently corrupt top hits. It should be applied to any custom or * scripted similarity. + * + * @opensearch.internal */ // public for testing public final class NonNegativeScoresSimilarity extends Similarity { diff --git a/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarity.java b/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarity.java index 27be5658448d1..53604606887eb 100644 --- a/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarity.java +++ b/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarity.java @@ -43,6 +43,8 @@ /** * A {@link Similarity} implementation that allows scores to be scripted. + * + * @opensearch.internal */ public final class ScriptedSimilarity extends Similarity { diff --git a/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarityProvider.java b/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarityProvider.java index c84293d06b0f7..ab1c0341ef3dc 100644 --- a/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarityProvider.java +++ b/server/src/main/java/org/opensearch/index/similarity/ScriptedSimilarityProvider.java @@ -41,7 +41,11 @@ import org.opensearch.script.SimilarityScript; import org.opensearch.script.SimilarityWeightScript; -/** Provider of scripted similarities. */ +/** + * Provider of scripted similarities. + * + * @opensearch.internal + */ final class ScriptedSimilarityProvider implements TriFunction { @Override diff --git a/server/src/main/java/org/opensearch/index/similarity/SimilarityProvider.java b/server/src/main/java/org/opensearch/index/similarity/SimilarityProvider.java index 9a4444e9ac0f6..ad64f3a55228f 100644 --- a/server/src/main/java/org/opensearch/index/similarity/SimilarityProvider.java +++ b/server/src/main/java/org/opensearch/index/similarity/SimilarityProvider.java @@ -38,6 +38,8 @@ /** * Wrapper around a {@link Similarity} and its name. + * + * @opensearch.internal */ public final class SimilarityProvider { diff --git a/server/src/main/java/org/opensearch/index/similarity/SimilarityProviders.java b/server/src/main/java/org/opensearch/index/similarity/SimilarityProviders.java index 3617c9607a3ab..1e3ec368df411 100644 --- a/server/src/main/java/org/opensearch/index/similarity/SimilarityProviders.java +++ b/server/src/main/java/org/opensearch/index/similarity/SimilarityProviders.java @@ -76,6 +76,11 @@ import static java.util.Collections.unmodifiableMap; +/** + * A provider for similarity computations + * + * @opensearch.internal + */ final class SimilarityProviders { private SimilarityProviders() {} // no instantiation diff --git a/server/src/main/java/org/opensearch/index/similarity/SimilarityService.java b/server/src/main/java/org/opensearch/index/similarity/SimilarityService.java index bb82d53de815a..1bfcc302c3bfc 100644 --- a/server/src/main/java/org/opensearch/index/similarity/SimilarityService.java +++ b/server/src/main/java/org/opensearch/index/similarity/SimilarityService.java @@ -62,6 +62,11 @@ import java.util.function.Function; import java.util.function.Supplier; +/** + * Service for similarity computations + * + * @opensearch.internal + */ public final class SimilarityService extends AbstractIndexComponent { private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(SimilarityService.class); public static final String DEFAULT_SIMILARITY = "BM25"; diff --git a/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreException.java b/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreException.java index 7dbc3ff60dd74..af2fedc36c60d 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreException.java +++ b/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreException.java @@ -40,6 +40,8 @@ /** * Generic shard restore exception + * + * @opensearch.internal */ public class IndexShardRestoreException extends OpenSearchException { public IndexShardRestoreException(ShardId shardId, String msg) { diff --git a/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreFailedException.java b/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreFailedException.java index 3850f853cc914..07cc1367e72b5 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreFailedException.java +++ b/server/src/main/java/org/opensearch/index/snapshots/IndexShardRestoreFailedException.java @@ -39,6 +39,8 @@ /** * Thrown when restore of a shard fails + * + * @opensearch.internal */ public class IndexShardRestoreFailedException extends IndexShardRestoreException { public IndexShardRestoreFailedException(ShardId shardId, String msg) { diff --git a/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotException.java b/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotException.java index db7550c964299..0d8001ec3d730 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotException.java +++ b/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotException.java @@ -40,6 +40,8 @@ /** * Generic shard snapshot exception + * + * @opensearch.internal */ public class IndexShardSnapshotException extends OpenSearchException { public IndexShardSnapshotException(ShardId shardId, String msg) { diff --git a/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotFailedException.java b/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotFailedException.java index 236cd668f443d..db03dfc7f421c 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotFailedException.java +++ b/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotFailedException.java @@ -39,6 +39,8 @@ /** * Thrown when snapshot process is failed on a shard level + * + * @opensearch.internal */ public class IndexShardSnapshotFailedException extends IndexShardSnapshotException { public IndexShardSnapshotFailedException(ShardId shardId, String msg) { diff --git a/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotStatus.java b/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotStatus.java index fa7da12c18adf..f0ce45e290c16 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotStatus.java +++ b/server/src/main/java/org/opensearch/index/snapshots/IndexShardSnapshotStatus.java @@ -37,6 +37,8 @@ /** * Represent shard snapshot status + * + * @opensearch.internal */ public class IndexShardSnapshotStatus { diff --git a/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java b/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java index 516fc19da1c8f..f3b6e91a79535 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java +++ b/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshot.java @@ -54,6 +54,8 @@ /** * Shard snapshot metadata + * + * @opensearch.internal */ public class BlobStoreIndexShardSnapshot implements ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java b/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java index 87d04e2e01bd2..4f59f65e25553 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java +++ b/server/src/main/java/org/opensearch/index/snapshots/blobstore/BlobStoreIndexShardSnapshots.java @@ -55,6 +55,8 @@ *

    * This class is used to find files that were already snapshotted and clear out files that no longer referenced by any * snapshots. + * + * @opensearch.internal */ public class BlobStoreIndexShardSnapshots implements Iterable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/index/snapshots/blobstore/RateLimitingInputStream.java b/server/src/main/java/org/opensearch/index/snapshots/blobstore/RateLimitingInputStream.java index 6b5ce49289ac7..b95814f92624c 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/blobstore/RateLimitingInputStream.java +++ b/server/src/main/java/org/opensearch/index/snapshots/blobstore/RateLimitingInputStream.java @@ -41,6 +41,8 @@ /** * Rate limiting wrapper for InputStream + * + * @opensearch.internal */ public class RateLimitingInputStream extends FilterInputStream { diff --git a/server/src/main/java/org/opensearch/index/snapshots/blobstore/SlicedInputStream.java b/server/src/main/java/org/opensearch/index/snapshots/blobstore/SlicedInputStream.java index c5b227341fbe5..b9b27547fe50c 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/blobstore/SlicedInputStream.java +++ b/server/src/main/java/org/opensearch/index/snapshots/blobstore/SlicedInputStream.java @@ -43,6 +43,8 @@ * of all logical sub-streams ahead of time. Instead, {@link #openSlice(int)} is called * if a new slice is required. Each slice is closed once it's been fully consumed or if * close is called before. + * + * @opensearch.internal */ public abstract class SlicedInputStream extends InputStream { private int slice = 0; diff --git a/server/src/main/java/org/opensearch/index/snapshots/blobstore/SnapshotFiles.java b/server/src/main/java/org/opensearch/index/snapshots/blobstore/SnapshotFiles.java index 81075472c00da..9ac002f2bc60c 100644 --- a/server/src/main/java/org/opensearch/index/snapshots/blobstore/SnapshotFiles.java +++ b/server/src/main/java/org/opensearch/index/snapshots/blobstore/SnapshotFiles.java @@ -41,6 +41,8 @@ /** * Contains a list of files participating in a snapshot + * + * @opensearch.internal */ public class SnapshotFiles { diff --git a/server/src/main/java/org/opensearch/index/stats/IndexingPressurePerShardStats.java b/server/src/main/java/org/opensearch/index/stats/IndexingPressurePerShardStats.java index 1786b02c38643..b93de9f3039e5 100644 --- a/server/src/main/java/org/opensearch/index/stats/IndexingPressurePerShardStats.java +++ b/server/src/main/java/org/opensearch/index/stats/IndexingPressurePerShardStats.java @@ -19,6 +19,11 @@ import java.io.IOException; +/** + * Per shard indexing pressure statistics + * + * @opensearch.internal + */ public class IndexingPressurePerShardStats implements Writeable, ToXContentFragment { private final String shardId; diff --git a/server/src/main/java/org/opensearch/index/stats/IndexingPressureStats.java b/server/src/main/java/org/opensearch/index/stats/IndexingPressureStats.java index fd13b170e3fc2..5a94dc104fcf8 100644 --- a/server/src/main/java/org/opensearch/index/stats/IndexingPressureStats.java +++ b/server/src/main/java/org/opensearch/index/stats/IndexingPressureStats.java @@ -42,6 +42,11 @@ import java.io.IOException; +/** + * Base indexing pressure statistics + * + * @opensearch.internal + */ public class IndexingPressureStats implements Writeable, ToXContentFragment { private final long totalCombinedCoordinatingAndPrimaryBytes; diff --git a/server/src/main/java/org/opensearch/index/stats/ShardIndexingPressureStats.java b/server/src/main/java/org/opensearch/index/stats/ShardIndexingPressureStats.java index 7e928e0e4c094..16f3cc418c820 100644 --- a/server/src/main/java/org/opensearch/index/stats/ShardIndexingPressureStats.java +++ b/server/src/main/java/org/opensearch/index/stats/ShardIndexingPressureStats.java @@ -20,6 +20,11 @@ import java.util.HashMap; import java.util.Map; +/** + * Cumulative shard indexing pressure stats + * + * @opensearch.internal + */ public class ShardIndexingPressureStats implements Writeable, ToXContentFragment { private final Map shardIndexingPressureStore; diff --git a/server/src/main/java/org/opensearch/index/store/ByteSizeCachingDirectory.java b/server/src/main/java/org/opensearch/index/store/ByteSizeCachingDirectory.java index f9af1847dfff6..76836391cb9d6 100644 --- a/server/src/main/java/org/opensearch/index/store/ByteSizeCachingDirectory.java +++ b/server/src/main/java/org/opensearch/index/store/ByteSizeCachingDirectory.java @@ -47,6 +47,11 @@ import java.nio.file.NoSuchFileException; import java.util.Set; +/** + * Caching directory sized in bytes + * + * @opensearch.internal + */ final class ByteSizeCachingDirectory extends FilterDirectory { private static class SizeAndModCount { diff --git a/server/src/main/java/org/opensearch/index/store/FsDirectoryFactory.java b/server/src/main/java/org/opensearch/index/store/FsDirectoryFactory.java index 2539968b20b0e..02e9eb50e7309 100644 --- a/server/src/main/java/org/opensearch/index/store/FsDirectoryFactory.java +++ b/server/src/main/java/org/opensearch/index/store/FsDirectoryFactory.java @@ -57,6 +57,11 @@ import java.util.HashSet; import java.util.Set; +/** + * Factory for a filesystem directory + * + * @opensearch.internal + */ public class FsDirectoryFactory implements IndexStorePlugin.DirectoryFactory { public static final Setting INDEX_LOCK_FACTOR_SETTING = new Setting<>("index.store.fs.fs_lock", "native", (s) -> { diff --git a/server/src/main/java/org/opensearch/index/store/Store.java b/server/src/main/java/org/opensearch/index/store/Store.java index f4a94023a8ac8..e21cf8e3e5b58 100644 --- a/server/src/main/java/org/opensearch/index/store/Store.java +++ b/server/src/main/java/org/opensearch/index/store/Store.java @@ -140,6 +140,8 @@ * store.decRef(); * } * + * + * @opensearch.internal */ public class Store extends AbstractIndexShardComponent implements Closeable, RefCounted { /** diff --git a/server/src/main/java/org/opensearch/index/store/StoreFileMetadata.java b/server/src/main/java/org/opensearch/index/store/StoreFileMetadata.java index ea8704fe0f06f..30bab979b46c5 100644 --- a/server/src/main/java/org/opensearch/index/store/StoreFileMetadata.java +++ b/server/src/main/java/org/opensearch/index/store/StoreFileMetadata.java @@ -44,6 +44,11 @@ import java.text.ParseException; import java.util.Objects; +/** + * Metadata for the store file + * + * @opensearch.internal + */ public class StoreFileMetadata implements Writeable { private final String name; diff --git a/server/src/main/java/org/opensearch/index/store/StoreStats.java b/server/src/main/java/org/opensearch/index/store/StoreStats.java index 7122fa853676b..fdda71aaaeebb 100644 --- a/server/src/main/java/org/opensearch/index/store/StoreStats.java +++ b/server/src/main/java/org/opensearch/index/store/StoreStats.java @@ -43,6 +43,11 @@ import java.io.IOException; +/** + * Statistics about an OpenSearch Store + * + * @opensearch.internal + */ public class StoreStats implements Writeable, ToXContentFragment { /** diff --git a/server/src/main/java/org/opensearch/index/store/VerifyingIndexOutput.java b/server/src/main/java/org/opensearch/index/store/VerifyingIndexOutput.java index 7c005d5abd175..507f7149319fe 100644 --- a/server/src/main/java/org/opensearch/index/store/VerifyingIndexOutput.java +++ b/server/src/main/java/org/opensearch/index/store/VerifyingIndexOutput.java @@ -40,6 +40,8 @@ /** * abstract class for verifying what was written. * subclasses override {@link #writeByte(byte)} and {@link #writeBytes(byte[], int, int)} + * + * @opensearch.internal */ // do NOT optimize this class for performance public abstract class VerifyingIndexOutput extends FilterIndexOutput { diff --git a/server/src/main/java/org/opensearch/index/termvectors/TermVectorsService.java b/server/src/main/java/org/opensearch/index/termvectors/TermVectorsService.java index 3467a86c86c86..7648f151851c0 100644 --- a/server/src/main/java/org/opensearch/index/termvectors/TermVectorsService.java +++ b/server/src/main/java/org/opensearch/index/termvectors/TermVectorsService.java @@ -83,6 +83,11 @@ import java.util.concurrent.TimeUnit; import java.util.function.LongSupplier; +/** + * Service for Term Vectors + * + * @opensearch.internal + */ public class TermVectorsService { private TermVectorsService() {} diff --git a/server/src/main/java/org/opensearch/index/translog/BaseTranslogReader.java b/server/src/main/java/org/opensearch/index/translog/BaseTranslogReader.java index 138ad9a221096..aaa54bfdf7c2d 100644 --- a/server/src/main/java/org/opensearch/index/translog/BaseTranslogReader.java +++ b/server/src/main/java/org/opensearch/index/translog/BaseTranslogReader.java @@ -43,6 +43,8 @@ /** * A base class for all classes that allows reading ops from translog files + * + * @opensearch.internal */ public abstract class BaseTranslogReader implements Comparable { diff --git a/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamInput.java b/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamInput.java index e93ba670ffd45..5feb994171b65 100644 --- a/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamInput.java +++ b/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamInput.java @@ -43,6 +43,8 @@ /** * Similar to Lucene's BufferedChecksumIndexInput, however this wraps a * {@link StreamInput} so anything read will update the checksum + * + * @opensearch.internal */ public final class BufferedChecksumStreamInput extends FilterStreamInput { private static final int SKIP_BUFFER_SIZE = 1024; diff --git a/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamOutput.java b/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamOutput.java index 9d2375df7a9d7..0efffccfb8a7f 100644 --- a/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamOutput.java +++ b/server/src/main/java/org/opensearch/index/translog/BufferedChecksumStreamOutput.java @@ -42,6 +42,8 @@ /** * Similar to Lucene's BufferedChecksumIndexOutput, however this wraps a * {@link StreamOutput} so anything written will update the checksum + * + * @opensearch.internal */ public final class BufferedChecksumStreamOutput extends StreamOutput { private final StreamOutput out; diff --git a/server/src/main/java/org/opensearch/index/translog/ChannelFactory.java b/server/src/main/java/org/opensearch/index/translog/ChannelFactory.java index 46eef80c95ff9..f86b9dea0a5f7 100644 --- a/server/src/main/java/org/opensearch/index/translog/ChannelFactory.java +++ b/server/src/main/java/org/opensearch/index/translog/ChannelFactory.java @@ -39,6 +39,8 @@ /** * only for testing until we have a disk-full FileSystem + * + * @opensearch.internal */ @FunctionalInterface public interface ChannelFactory { diff --git a/server/src/main/java/org/opensearch/index/translog/Checkpoint.java b/server/src/main/java/org/opensearch/index/translog/Checkpoint.java index 0cff884cabfaa..ade28791b2e27 100644 --- a/server/src/main/java/org/opensearch/index/translog/Checkpoint.java +++ b/server/src/main/java/org/opensearch/index/translog/Checkpoint.java @@ -54,6 +54,11 @@ import java.nio.file.OpenOption; import java.nio.file.Path; +/** + * A checkpoint for OpenSearch operations + * + * @opensearch.internal + */ final class Checkpoint { final long offset; diff --git a/server/src/main/java/org/opensearch/index/translog/DefaultTranslogDeletionPolicy.java b/server/src/main/java/org/opensearch/index/translog/DefaultTranslogDeletionPolicy.java index 1346a16910d58..efc762ef00d52 100644 --- a/server/src/main/java/org/opensearch/index/translog/DefaultTranslogDeletionPolicy.java +++ b/server/src/main/java/org/opensearch/index/translog/DefaultTranslogDeletionPolicy.java @@ -16,6 +16,8 @@ * via the {@link org.opensearch.plugins.EnginePlugin#getCustomTranslogDeletionPolicyFactory()}. * * The default policy uses total number, size in bytes and maximum age for files. + * + * @opensearch.internal */ public class DefaultTranslogDeletionPolicy extends TranslogDeletionPolicy { diff --git a/server/src/main/java/org/opensearch/index/translog/MultiSnapshot.java b/server/src/main/java/org/opensearch/index/translog/MultiSnapshot.java index 9a2fd009f4216..f1de0ddab97c4 100644 --- a/server/src/main/java/org/opensearch/index/translog/MultiSnapshot.java +++ b/server/src/main/java/org/opensearch/index/translog/MultiSnapshot.java @@ -42,6 +42,8 @@ /** * A snapshot composed out of multiple snapshots + * + * @opensearch.internal */ final class MultiSnapshot implements Translog.Snapshot { diff --git a/server/src/main/java/org/opensearch/index/translog/TragicExceptionHolder.java b/server/src/main/java/org/opensearch/index/translog/TragicExceptionHolder.java index 6a8fdc4a3d7a3..818d840cb11fd 100644 --- a/server/src/main/java/org/opensearch/index/translog/TragicExceptionHolder.java +++ b/server/src/main/java/org/opensearch/index/translog/TragicExceptionHolder.java @@ -37,6 +37,11 @@ import java.util.concurrent.atomic.AtomicReference; +/** + * Exception thrown if there are any massive OpenSearch failures + * + * @opensearch.internal + */ public class TragicExceptionHolder { private final AtomicReference tragedy = new AtomicReference<>(); diff --git a/server/src/main/java/org/opensearch/index/translog/Translog.java b/server/src/main/java/org/opensearch/index/translog/Translog.java index 25d84efbee38f..4a11db2bc6a1d 100644 --- a/server/src/main/java/org/opensearch/index/translog/Translog.java +++ b/server/src/main/java/org/opensearch/index/translog/Translog.java @@ -109,6 +109,8 @@ * which is an fsynced copy of its last {@code translog.ckp} such that in disaster recovery last fsynced offsets, number of * operation etc. are still preserved. *

    + * + * @opensearch.internal */ public class Translog extends AbstractIndexShardComponent implements IndexShardComponent, Closeable { diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogConfig.java b/server/src/main/java/org/opensearch/index/translog/TranslogConfig.java index b2928c8340870..1d01dc854be37 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogConfig.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogConfig.java @@ -40,10 +40,12 @@ import java.nio.file.Path; -/* +/** * Holds all the configuration that is used to create a {@link Translog}. * Once {@link Translog} has been created with this object, changes to this * object will affect the {@link Translog} instance. + * + * @opensearch.internal */ public final class TranslogConfig { diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogCorruptedException.java b/server/src/main/java/org/opensearch/index/translog/TranslogCorruptedException.java index 62159179eea13..cf3d07c0ef910 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogCorruptedException.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogCorruptedException.java @@ -37,6 +37,11 @@ import java.io.IOException; +/** + * Exception thrown if the translog is corrupted + * + * @opensearch.internal + */ public class TranslogCorruptedException extends OpenSearchException { public TranslogCorruptedException(String source, String details) { super(corruptedMessage(source, details)); diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicy.java b/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicy.java index 62f2703becca7..95f39c1188b2b 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicy.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicy.java @@ -44,6 +44,11 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicBoolean; +/** + * Defines a translog deletion policy + * + * @opensearch.internal + */ public abstract class TranslogDeletionPolicy { private final Map openTranslogRef; diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicyFactory.java b/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicyFactory.java index e964308a537ab..8f40fdc90368f 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicyFactory.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogDeletionPolicyFactory.java @@ -13,6 +13,11 @@ import java.util.function.Supplier; +/** + * Factory to instantiate a translog deletion policy + * + * @opensearch.api + */ @FunctionalInterface public interface TranslogDeletionPolicyFactory { TranslogDeletionPolicy create(IndexSettings settings, Supplier supplier); diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogException.java b/server/src/main/java/org/opensearch/index/translog/TranslogException.java index a162ab0fa019b..ffa964c13976e 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogException.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if there are any failures in the translog + * + * @opensearch.internal + */ public class TranslogException extends OpenSearchException { public TranslogException(ShardId shardId, String msg) { diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogHeader.java b/server/src/main/java/org/opensearch/index/translog/TranslogHeader.java index c6158ecc942b6..0819d009c9992 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogHeader.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogHeader.java @@ -53,6 +53,8 @@ /** * Each translog file is started with a translog header then followed by translog operations. + * + * @opensearch.internal */ final class TranslogHeader { public static final String TRANSLOG_CODEC = "translog"; diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogReader.java b/server/src/main/java/org/opensearch/index/translog/TranslogReader.java index 3c47ce2207e4b..9d22fe0a498eb 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogReader.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogReader.java @@ -50,6 +50,8 @@ /** * an immutable translog filereader + * + * @opensearch.internal */ public class TranslogReader extends BaseTranslogReader implements Closeable { protected final long length; diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogSnapshot.java b/server/src/main/java/org/opensearch/index/translog/TranslogSnapshot.java index c9b1383bb0206..89718156cbbe8 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogSnapshot.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogSnapshot.java @@ -38,6 +38,11 @@ import java.io.IOException; import java.nio.ByteBuffer; +/** + * A snapshot of translog operations + * + * @opensearch.internal + */ final class TranslogSnapshot extends BaseTranslogReader { private final int totalOperations; diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogStats.java b/server/src/main/java/org/opensearch/index/translog/TranslogStats.java index 427802140d927..6265ba60db555 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogStats.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogStats.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Translog statistics + * + * @opensearch.internal + */ public class TranslogStats implements Writeable, ToXContentFragment { private long translogSizeInBytes; diff --git a/server/src/main/java/org/opensearch/index/translog/TranslogWriter.java b/server/src/main/java/org/opensearch/index/translog/TranslogWriter.java index 66241f7b6847f..413975f82678b 100644 --- a/server/src/main/java/org/opensearch/index/translog/TranslogWriter.java +++ b/server/src/main/java/org/opensearch/index/translog/TranslogWriter.java @@ -68,6 +68,11 @@ import java.util.function.LongConsumer; import java.util.function.LongSupplier; +/** + * Writer that writes operations to the translog + * + * @opensearch.internal + */ public class TranslogWriter extends BaseTranslogReader implements Closeable { private final ShardId shardId; diff --git a/server/src/main/java/org/opensearch/index/translog/TruncateTranslogAction.java b/server/src/main/java/org/opensearch/index/translog/TruncateTranslogAction.java index 7d30fe2e2ffe3..33294eb9e7d24 100644 --- a/server/src/main/java/org/opensearch/index/translog/TruncateTranslogAction.java +++ b/server/src/main/java/org/opensearch/index/translog/TruncateTranslogAction.java @@ -67,6 +67,11 @@ import java.util.Set; import java.util.TreeSet; +/** + * Action event when translog is truncated + * + * @opensearch.internal + */ public class TruncateTranslogAction { protected static final Logger logger = LogManager.getLogger(TruncateTranslogAction.class); diff --git a/server/src/main/java/org/opensearch/index/translog/TruncatedTranslogException.java b/server/src/main/java/org/opensearch/index/translog/TruncatedTranslogException.java index 8ae7a65727537..3660e2c835e11 100644 --- a/server/src/main/java/org/opensearch/index/translog/TruncatedTranslogException.java +++ b/server/src/main/java/org/opensearch/index/translog/TruncatedTranslogException.java @@ -36,6 +36,11 @@ import java.io.IOException; +/** + * Exception thrown if there is an error truncating the translog + * + * @opensearch.internal + */ public class TruncatedTranslogException extends TranslogCorruptedException { public TruncatedTranslogException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/index/warmer/ShardIndexWarmerService.java b/server/src/main/java/org/opensearch/index/warmer/ShardIndexWarmerService.java index 225400818f200..c690ed8c1c385 100644 --- a/server/src/main/java/org/opensearch/index/warmer/ShardIndexWarmerService.java +++ b/server/src/main/java/org/opensearch/index/warmer/ShardIndexWarmerService.java @@ -41,6 +41,11 @@ import java.util.concurrent.TimeUnit; +/** + * Warms the index into the cache + * + * @opensearch.internal + */ public class ShardIndexWarmerService extends AbstractIndexShardComponent { private final CounterMetric current = new CounterMetric(); diff --git a/server/src/main/java/org/opensearch/index/warmer/WarmerStats.java b/server/src/main/java/org/opensearch/index/warmer/WarmerStats.java index 0d4241aa534ec..79fba31d015d3 100644 --- a/server/src/main/java/org/opensearch/index/warmer/WarmerStats.java +++ b/server/src/main/java/org/opensearch/index/warmer/WarmerStats.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Stats collected about the warmer + * + * @opensearch.internal + */ public class WarmerStats implements Writeable, ToXContentFragment { private long current; diff --git a/server/src/main/java/org/opensearch/indices/AbstractIndexShardCacheEntity.java b/server/src/main/java/org/opensearch/indices/AbstractIndexShardCacheEntity.java index 4717867a5245d..c0202f099f4e0 100644 --- a/server/src/main/java/org/opensearch/indices/AbstractIndexShardCacheEntity.java +++ b/server/src/main/java/org/opensearch/indices/AbstractIndexShardCacheEntity.java @@ -39,6 +39,8 @@ /** * Abstract base class for the an {@link IndexShard} level {@linkplain IndicesRequestCache.CacheEntity}. + * + * @opensearch.internal */ abstract class AbstractIndexShardCacheEntity implements IndicesRequestCache.CacheEntity { diff --git a/server/src/main/java/org/opensearch/indices/AliasFilterParsingException.java b/server/src/main/java/org/opensearch/indices/AliasFilterParsingException.java index 0a2c292ab7765..494824b11bafe 100644 --- a/server/src/main/java/org/opensearch/indices/AliasFilterParsingException.java +++ b/server/src/main/java/org/opensearch/indices/AliasFilterParsingException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown for parsing alias filters + * + * @opensearch.internal + */ public class AliasFilterParsingException extends OpenSearchException { public AliasFilterParsingException(Index index, String name, String desc, Throwable ex) { diff --git a/server/src/main/java/org/opensearch/indices/IndexClosedException.java b/server/src/main/java/org/opensearch/indices/IndexClosedException.java index aa2971e598e06..64ffcf173f46f 100644 --- a/server/src/main/java/org/opensearch/indices/IndexClosedException.java +++ b/server/src/main/java/org/opensearch/indices/IndexClosedException.java @@ -41,6 +41,8 @@ /** * Exception indicating that one or more requested indices are closed. + * + * @opensearch.internal */ public class IndexClosedException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/indices/IndexCreationException.java b/server/src/main/java/org/opensearch/indices/IndexCreationException.java index fde1ad623fa12..2eca5c8f0a5d9 100644 --- a/server/src/main/java/org/opensearch/indices/IndexCreationException.java +++ b/server/src/main/java/org/opensearch/indices/IndexCreationException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if there is an error creating an index + * + * @opensearch.internal + */ public class IndexCreationException extends OpenSearchException implements OpenSearchWrapperException { public IndexCreationException(String index, Throwable cause) { diff --git a/server/src/main/java/org/opensearch/indices/IndexPrimaryShardNotAllocatedException.java b/server/src/main/java/org/opensearch/indices/IndexPrimaryShardNotAllocatedException.java index 2e680e6d0aa77..a646ae53ecc5a 100644 --- a/server/src/main/java/org/opensearch/indices/IndexPrimaryShardNotAllocatedException.java +++ b/server/src/main/java/org/opensearch/indices/IndexPrimaryShardNotAllocatedException.java @@ -42,6 +42,8 @@ /** * Thrown when some action cannot be performed because the primary shard of * some shard group in an index has not been allocated post api action. + * + * @opensearch.internal */ public class IndexPrimaryShardNotAllocatedException extends OpenSearchException { public IndexPrimaryShardNotAllocatedException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/indices/IndexTemplateMissingException.java b/server/src/main/java/org/opensearch/indices/IndexTemplateMissingException.java index fde9ef3712cf0..78060c1b3a072 100644 --- a/server/src/main/java/org/opensearch/indices/IndexTemplateMissingException.java +++ b/server/src/main/java/org/opensearch/indices/IndexTemplateMissingException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if an index template is missing + * + * @opensearch.internal + */ public class IndexTemplateMissingException extends OpenSearchException { private final String name; diff --git a/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java b/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java index 1917a224e5410..ae51a525765ba 100644 --- a/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java +++ b/server/src/main/java/org/opensearch/indices/IndexingMemoryController.java @@ -62,6 +62,11 @@ import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.locks.ReentrantLock; +/** + * Memory controller for indexing operations + * + * @opensearch.internal + */ public class IndexingMemoryController implements IndexingOperationListener, Closeable { private static final Logger logger = LogManager.getLogger(IndexingMemoryController.class); diff --git a/server/src/main/java/org/opensearch/indices/IndicesModule.java b/server/src/main/java/org/opensearch/indices/IndicesModule.java index 5e59908e741ba..f188c47e7a9de 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesModule.java +++ b/server/src/main/java/org/opensearch/indices/IndicesModule.java @@ -89,6 +89,8 @@ /** * Configures classes and services that are shared by indices on each node. + * + * @opensearch.internal */ public class IndicesModule extends AbstractModule { private final List namedWritables = new ArrayList<>(); diff --git a/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java b/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java index 2cbb83fde278d..ce94d769f9c31 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java +++ b/server/src/main/java/org/opensearch/indices/IndicesQueryCache.java @@ -62,6 +62,11 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.function.Predicate; +/** + * The query cache for indices + * + * @opensearch.internal + */ public class IndicesQueryCache implements QueryCache, Closeable { private static final Logger logger = LogManager.getLogger(IndicesQueryCache.class); diff --git a/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java b/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java index d82ec0afc2c98..920d3492e0b62 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java +++ b/server/src/main/java/org/opensearch/indices/IndicesRequestCache.java @@ -76,6 +76,8 @@ *

    * There are still several TODOs left in this class, some easily addressable, some more complex, but the support * is functional. + * + * @opensearch.internal */ public final class IndicesRequestCache implements RemovalListener, Closeable { diff --git a/server/src/main/java/org/opensearch/indices/IndicesService.java b/server/src/main/java/org/opensearch/indices/IndicesService.java index 5caafb0ce60d4..87cd63119f1d4 100644 --- a/server/src/main/java/org/opensearch/indices/IndicesService.java +++ b/server/src/main/java/org/opensearch/indices/IndicesService.java @@ -189,6 +189,11 @@ import static org.opensearch.index.query.AbstractQueryBuilder.parseInnerQueryBuilder; import static org.opensearch.search.SearchService.ALLOW_EXPENSIVE_QUERIES; +/** + * Main OpenSearch indices service + * + * @opensearch.internal + */ public class IndicesService extends AbstractLifecycleComponent implements IndicesClusterStateService.AllocatedIndices, diff --git a/server/src/main/java/org/opensearch/indices/InvalidAliasNameException.java b/server/src/main/java/org/opensearch/indices/InvalidAliasNameException.java index 3658ffe8e588b..47184fc608bea 100644 --- a/server/src/main/java/org/opensearch/indices/InvalidAliasNameException.java +++ b/server/src/main/java/org/opensearch/indices/InvalidAliasNameException.java @@ -39,6 +39,11 @@ import java.io.IOException; +/** + * Exception thrown if an alias name is invalid + * + * @opensearch.internal + */ public class InvalidAliasNameException extends OpenSearchException { public InvalidAliasNameException(Index index, String name, String desc) { diff --git a/server/src/main/java/org/opensearch/indices/InvalidIndexNameException.java b/server/src/main/java/org/opensearch/indices/InvalidIndexNameException.java index b9df6569ebbf3..631aaa937cf63 100644 --- a/server/src/main/java/org/opensearch/indices/InvalidIndexNameException.java +++ b/server/src/main/java/org/opensearch/indices/InvalidIndexNameException.java @@ -39,6 +39,11 @@ import java.io.IOException; +/** + * Exception thrown if an index name is invalid + * + * @opensearch.internal + */ public class InvalidIndexNameException extends OpenSearchException { public InvalidIndexNameException(String name, String desc) { diff --git a/server/src/main/java/org/opensearch/indices/InvalidIndexTemplateException.java b/server/src/main/java/org/opensearch/indices/InvalidIndexTemplateException.java index 3ecbfe1e70edd..17a7334e6867a 100644 --- a/server/src/main/java/org/opensearch/indices/InvalidIndexTemplateException.java +++ b/server/src/main/java/org/opensearch/indices/InvalidIndexTemplateException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if an index template is invalid + * + * @opensearch.internal + */ public class InvalidIndexTemplateException extends OpenSearchException { private final String name; diff --git a/server/src/main/java/org/opensearch/indices/InvalidTypeNameException.java b/server/src/main/java/org/opensearch/indices/InvalidTypeNameException.java index d240cf6f83ff7..1e33488b6fb8a 100644 --- a/server/src/main/java/org/opensearch/indices/InvalidTypeNameException.java +++ b/server/src/main/java/org/opensearch/indices/InvalidTypeNameException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if a type is invalid + * + * @opensearch.internal + */ public class InvalidTypeNameException extends MapperException { public InvalidTypeNameException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java b/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java index 8e89894cbc78e..b6eedb338b006 100644 --- a/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java +++ b/server/src/main/java/org/opensearch/indices/NodeIndicesStats.java @@ -67,6 +67,8 @@ /** * Global information on indices stats running on a specific node. + * + * @opensearch.internal */ public class NodeIndicesStats implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/indices/ShardLimitValidator.java b/server/src/main/java/org/opensearch/indices/ShardLimitValidator.java index 7e4376e8ea8de..a5ec6cbecaf55 100644 --- a/server/src/main/java/org/opensearch/indices/ShardLimitValidator.java +++ b/server/src/main/java/org/opensearch/indices/ShardLimitValidator.java @@ -53,6 +53,8 @@ * NOTE: This is the limit applied at *shard creation time*. If you are looking for the limit applied at *allocation* time, which is * controlled by a different setting, * see {@link org.opensearch.cluster.routing.allocation.decider.ShardsLimitAllocationDecider}. + * + * @opensearch.internal */ public class ShardLimitValidator { public static final Setting SETTING_CLUSTER_MAX_SHARDS_PER_NODE = Setting.intSetting( diff --git a/server/src/main/java/org/opensearch/indices/SystemIndexDescriptor.java b/server/src/main/java/org/opensearch/indices/SystemIndexDescriptor.java index 9e41fe8943474..f3592a3561d3a 100644 --- a/server/src/main/java/org/opensearch/indices/SystemIndexDescriptor.java +++ b/server/src/main/java/org/opensearch/indices/SystemIndexDescriptor.java @@ -39,6 +39,8 @@ /** * Describes a system index. Provides the information required to create and maintain the system index. + * + * @opensearch.internal */ public class SystemIndexDescriptor { private final String indexPattern; diff --git a/server/src/main/java/org/opensearch/indices/SystemIndices.java b/server/src/main/java/org/opensearch/indices/SystemIndices.java index 042291554670c..3d5df507348fb 100644 --- a/server/src/main/java/org/opensearch/indices/SystemIndices.java +++ b/server/src/main/java/org/opensearch/indices/SystemIndices.java @@ -63,6 +63,8 @@ * This class holds the {@link SystemIndexDescriptor} objects that represent system indices the * node knows about. Methods for determining if an index should be a system index are also provided * to reduce the locations within the code that need to deal with {@link SystemIndexDescriptor}s. + * + * @opensearch.internal */ public class SystemIndices { private static final Logger logger = LogManager.getLogger(SystemIndices.class); diff --git a/server/src/main/java/org/opensearch/indices/TermsLookup.java b/server/src/main/java/org/opensearch/indices/TermsLookup.java index bf6c024fa130e..0aed352bc3664 100644 --- a/server/src/main/java/org/opensearch/indices/TermsLookup.java +++ b/server/src/main/java/org/opensearch/indices/TermsLookup.java @@ -51,6 +51,8 @@ /** * Encapsulates the parameters needed to fetch terms. + * + * @opensearch.internal */ public class TermsLookup implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/indices/TypeMissingException.java b/server/src/main/java/org/opensearch/indices/TypeMissingException.java index 3392979fdbc0d..a57e62bf2a76e 100644 --- a/server/src/main/java/org/opensearch/indices/TypeMissingException.java +++ b/server/src/main/java/org/opensearch/indices/TypeMissingException.java @@ -40,6 +40,14 @@ import java.io.IOException; import java.util.Arrays; +/** + * Exception thrown if a document type is missing + * + * @opensearch.internal + * + * @deprecated Types are removed + */ +@Deprecated public class TypeMissingException extends OpenSearchException { public TypeMissingException(Index index, String... types) { diff --git a/server/src/main/java/org/opensearch/indices/analysis/AnalysisModule.java b/server/src/main/java/org/opensearch/indices/analysis/AnalysisModule.java index 5d43bfa8876c8..cc87c982a684d 100644 --- a/server/src/main/java/org/opensearch/indices/analysis/AnalysisModule.java +++ b/server/src/main/java/org/opensearch/indices/analysis/AnalysisModule.java @@ -74,6 +74,8 @@ /** * Sets up {@link AnalysisRegistry}. + * + * @opensearch.internal */ public final class AnalysisModule { static { diff --git a/server/src/main/java/org/opensearch/indices/analysis/HunspellService.java b/server/src/main/java/org/opensearch/indices/analysis/HunspellService.java index 08f8b18920eb9..61191a1e49f63 100644 --- a/server/src/main/java/org/opensearch/indices/analysis/HunspellService.java +++ b/server/src/main/java/org/opensearch/indices/analysis/HunspellService.java @@ -87,6 +87,8 @@ * * * @see org.opensearch.index.analysis.HunspellTokenFilterFactory + * + * @opensearch.internal */ public class HunspellService { diff --git a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltAnalyzers.java b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltAnalyzers.java index 640100bbcc082..fad9c7d6c61cc 100644 --- a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltAnalyzers.java +++ b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltAnalyzers.java @@ -45,6 +45,11 @@ import java.util.Locale; +/** + * Pre built analyzers + * + * @opensearch.internal + */ public enum PreBuiltAnalyzers { STANDARD(CachingStrategy.OPENSEARCH) { 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 f53c1b5568584..192301c7bd9cf 100644 --- a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltCacheFactory.java +++ b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltCacheFactory.java @@ -39,6 +39,11 @@ import java.util.HashMap; import java.util.Map; +/** + * A factory for the pre-built cache + * + * @opensearch.internal + */ public class PreBuiltCacheFactory { /** diff --git a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltTokenizers.java b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltTokenizers.java index 3499e63501efd..c68f8fe6c3ba5 100644 --- a/server/src/main/java/org/opensearch/indices/analysis/PreBuiltTokenizers.java +++ b/server/src/main/java/org/opensearch/indices/analysis/PreBuiltTokenizers.java @@ -37,6 +37,11 @@ import org.opensearch.index.analysis.TokenFilterFactory; import org.opensearch.indices.analysis.PreBuiltCacheFactory.CachingStrategy; +/** + * Pre-built tokenizers for analysis + * + * @opensearch.internal + */ public enum PreBuiltTokenizers { STANDARD(CachingStrategy.ONE) { 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 4c737774fc42e..01284d42a3cf9 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java +++ b/server/src/main/java/org/opensearch/indices/breaker/AllCircuitBreakerStats.java @@ -42,6 +42,8 @@ /** * Stats class encapsulating all of the different circuit breaker stats + * + * @opensearch.internal */ public class AllCircuitBreakerStats implements Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/indices/breaker/BreakerSettings.java b/server/src/main/java/org/opensearch/indices/breaker/BreakerSettings.java index 97c851e036778..a421253227dbf 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/BreakerSettings.java +++ b/server/src/main/java/org/opensearch/indices/breaker/BreakerSettings.java @@ -39,6 +39,8 @@ /** * Settings for a {@link CircuitBreaker} + * + * @opensearch.internal */ public final class BreakerSettings { diff --git a/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerService.java b/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerService.java index fd7ce00fde798..b5cc1a6b1c6c5 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerService.java +++ b/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerService.java @@ -40,6 +40,8 @@ /** * Interface for Circuit Breaker services, which provide breakers to classes * that load field data. + * + * @opensearch.internal */ public abstract class CircuitBreakerService extends AbstractLifecycleComponent { private static final Logger logger = LogManager.getLogger(CircuitBreakerService.class); 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 4c67e4ce21a33..64bf4c16a6059 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerStats.java +++ b/server/src/main/java/org/opensearch/indices/breaker/CircuitBreakerStats.java @@ -44,6 +44,8 @@ /** * Class encapsulating stats about the circuit breaker + * + * @opensearch.internal */ public class CircuitBreakerStats implements Writeable, ToXContentObject { 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 ec5d1edf3c448..02d1e1a76f3f1 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/HierarchyCircuitBreakerService.java +++ b/server/src/main/java/org/opensearch/indices/breaker/HierarchyCircuitBreakerService.java @@ -71,6 +71,8 @@ /** * CircuitBreakerService that attempts to redistribute space between breakers * if tripped + * + * @opensearch.internal */ public class HierarchyCircuitBreakerService extends CircuitBreakerService { private static final Logger logger = LogManager.getLogger(HierarchyCircuitBreakerService.class); diff --git a/server/src/main/java/org/opensearch/indices/breaker/NoneCircuitBreakerService.java b/server/src/main/java/org/opensearch/indices/breaker/NoneCircuitBreakerService.java index ef77598b20009..bcb47b48a5f14 100644 --- a/server/src/main/java/org/opensearch/indices/breaker/NoneCircuitBreakerService.java +++ b/server/src/main/java/org/opensearch/indices/breaker/NoneCircuitBreakerService.java @@ -37,6 +37,8 @@ /** * Class that returns a breaker that never breaks + * + * @opensearch.internal */ public class NoneCircuitBreakerService extends CircuitBreakerService { 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 b7f8bc5a4e502..d06b33b121667 100644 --- a/server/src/main/java/org/opensearch/indices/cluster/IndicesClusterStateService.java +++ b/server/src/main/java/org/opensearch/indices/cluster/IndicesClusterStateService.java @@ -106,6 +106,11 @@ import static org.opensearch.indices.cluster.IndicesClusterStateService.AllocatedIndices.IndexRemovalReason.NO_LONGER_ASSIGNED; import static org.opensearch.indices.cluster.IndicesClusterStateService.AllocatedIndices.IndexRemovalReason.REOPENED; +/** + * Service to update the cluster state for multiple indices + * + * @opensearch.internal + */ public class IndicesClusterStateService extends AbstractLifecycleComponent implements ClusterStateApplier { private static final Logger logger = LogManager.getLogger(IndicesClusterStateService.class); 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 a632175e0a609..01e00fdc19899 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 @@ -64,6 +64,11 @@ import java.util.List; import java.util.function.ToLongBiFunction; +/** + * The field data cache for multiple indices + * + * @opensearch.internal + */ public class IndicesFieldDataCache implements RemovalListener, Releasable { private static final Logger logger = LogManager.getLogger(IndicesFieldDataCache.class); diff --git a/server/src/main/java/org/opensearch/indices/mapper/MapperRegistry.java b/server/src/main/java/org/opensearch/indices/mapper/MapperRegistry.java index 23ce1b277aeeb..3a1d7b1ebb1e3 100644 --- a/server/src/main/java/org/opensearch/indices/mapper/MapperRegistry.java +++ b/server/src/main/java/org/opensearch/indices/mapper/MapperRegistry.java @@ -46,6 +46,8 @@ /** * A registry for all field mappers. + * + * @opensearch.internal */ public final class MapperRegistry { diff --git a/server/src/main/java/org/opensearch/indices/recovery/DelayRecoveryException.java b/server/src/main/java/org/opensearch/indices/recovery/DelayRecoveryException.java index 994634cb43413..bd88dcc236fb4 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/DelayRecoveryException.java +++ b/server/src/main/java/org/opensearch/indices/recovery/DelayRecoveryException.java @@ -40,7 +40,7 @@ /** * An exception marking that this recovery attempt should be ignored (since probably, we already recovered). * - * + * @opensearch.internal */ public class DelayRecoveryException extends OpenSearchException { 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 78983c9ab5cf8..8a6aa0db26610 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/MultiChunkTransfer.java +++ b/server/src/main/java/org/opensearch/indices/recovery/MultiChunkTransfer.java @@ -68,6 +68,8 @@ * greater than {@code maxConcurrentFileChunks}), the sending/requesting thread will abort its execution. That process will be resumed by * one of the networking threads which receive/handle the responses of the current pending file chunk requests. This process will continue * until all chunk requests are sent/responded. + * + * @opensearch.internal */ public abstract class MultiChunkTransfer implements Closeable { private Status status = Status.PROCESSING; 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 f0295fdd2fbef..285be4346071d 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/MultiFileWriter.java +++ b/server/src/main/java/org/opensearch/indices/recovery/MultiFileWriter.java @@ -56,6 +56,11 @@ import java.util.concurrent.ConcurrentMap; import java.util.concurrent.atomic.AtomicBoolean; +/** + * A multi file writer utility for recovery + * + * @opensearch.internal + */ public class MultiFileWriter extends AbstractRefCounted implements Releasable { public MultiFileWriter(Store store, RecoveryState.Index indexState, String tempFilePrefix, Logger logger, Runnable ensureOpen) { diff --git a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryNotFound.java b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryNotFound.java index 30a0f8053b109..478dabba7aef0 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryNotFound.java +++ b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryNotFound.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception thrown if peer recovery is not found + * + * @opensearch.internal + */ public class PeerRecoveryNotFound extends ResourceNotFoundException { public PeerRecoveryNotFound(final long recoveryId, final ShardId shardId, final String targetAllocationId) { 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 5e9db2e1d67f3..1eb0fe2c1929d 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoverySourceService.java +++ b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoverySourceService.java @@ -72,6 +72,8 @@ /** * The source recovery accepts recovery requests from other peer shards and start the recovery process from this * source shard to the target shard. + * + * @opensearch.internal */ public class PeerRecoverySourceService extends AbstractLifecycleComponent implements IndexEventListener, ClusterStateListener { 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 9348988f8edcc..6f1c199527596 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryTargetService.java +++ b/server/src/main/java/org/opensearch/indices/recovery/PeerRecoveryTargetService.java @@ -94,6 +94,8 @@ *

    * Note, it can be safely assumed that there will only be a single recovery per shard (index+id) and * not several of them (since we don't allocate several shard replicas to the same node). + * + * @opensearch.internal */ public class PeerRecoveryTargetService implements IndexEventListener { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoverFilesRecoveryException.java b/server/src/main/java/org/opensearch/indices/recovery/RecoverFilesRecoveryException.java index d3ac3319bf2f0..fe7bba1769463 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoverFilesRecoveryException.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoverFilesRecoveryException.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Exception thrown if there is an error recovering files + * + * @opensearch.internal + */ public class RecoverFilesRecoveryException extends OpenSearchException implements OpenSearchWrapperException { private final int numberOfFiles; 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 0b2dd9804067e..0312dfeec4eeb 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveriesCollection.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveriesCollection.java @@ -55,6 +55,8 @@ * of those recoveries). The class is used to guarantee concurrent semantics such that once a recoveries was done/cancelled/failed * no other thread will be able to find it. Last, the {@link RecoveryRef} inner class verifies that recovery temporary files * and store will only be cleared once on going usage is finished. + * + * @opensearch.internal */ public class RecoveriesCollection { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryCleanFilesRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryCleanFilesRequest.java index 974bba9673d43..6c597fcd086c4 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryCleanFilesRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryCleanFilesRequest.java @@ -41,6 +41,11 @@ import java.io.IOException; +/** + * Request to clean up recovery files + * + * @opensearch.internal + */ public class RecoveryCleanFilesRequest extends RecoveryTransportRequest { private final long recoveryId; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFailedException.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFailedException.java index 5293286269659..f2665e8bbb1a7 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFailedException.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFailedException.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Exception thrown if recovery fails + * + * @opensearch.internal + */ public class RecoveryFailedException extends OpenSearchException { public RecoveryFailedException(StartRecoveryRequest request, Throwable cause) { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFileChunkRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFileChunkRequest.java index 2a0357547048a..886de8d56645c 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFileChunkRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFileChunkRequest.java @@ -42,6 +42,11 @@ import java.io.IOException; +/** + * Request for a recovery file chunk + * + * @opensearch.internal + */ public final class RecoveryFileChunkRequest extends RecoveryTransportRequest { private final boolean lastChunk; private final long recoveryId; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFilesInfoRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFilesInfoRequest.java index 6c1b29e155dd0..dccadfcf49cf1 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFilesInfoRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFilesInfoRequest.java @@ -40,6 +40,11 @@ import java.util.ArrayList; import java.util.List; +/** + * Request for recovery file information + * + * @opensearch.internal + */ public class RecoveryFilesInfoRequest extends RecoveryTransportRequest { private long recoveryId; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFinalizeRecoveryRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFinalizeRecoveryRequest.java index f3ef74e1fdf59..a7334fba15664 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryFinalizeRecoveryRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryFinalizeRecoveryRequest.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Request to finalize recovery + * + * @opensearch.internal + */ final class RecoveryFinalizeRecoveryRequest extends RecoveryTransportRequest { private final long recoveryId; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryHandoffPrimaryContextRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryHandoffPrimaryContextRequest.java index 048de6edade73..4e47668d82656 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryHandoffPrimaryContextRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryHandoffPrimaryContextRequest.java @@ -42,6 +42,8 @@ /** * The request object to handoff the primary context to the relocation target. + * + * @opensearch.internal */ class RecoveryHandoffPrimaryContextRequest extends TransportRequest { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryPrepareForTranslogOperationsRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryPrepareForTranslogOperationsRequest.java index 579643bd62763..bdacb0b724884 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryPrepareForTranslogOperationsRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryPrepareForTranslogOperationsRequest.java @@ -39,6 +39,11 @@ import java.io.IOException; +/** + * Request to prepare cluster for translog operations + * + * @opensearch.internal + */ class RecoveryPrepareForTranslogOperationsRequest extends RecoveryTransportRequest { private final long recoveryId; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryRequestTracker.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryRequestTracker.java index 048a8019d2cda..71a7f2776f324 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryRequestTracker.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryRequestTracker.java @@ -44,6 +44,11 @@ import static org.opensearch.index.seqno.SequenceNumbers.NO_OPS_PERFORMED; +/** + * Tracks recovery requests + * + * @opensearch.internal + */ public class RecoveryRequestTracker { private final Map> ongoingRequests = Collections.synchronizedMap(new HashMap<>()); diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryResponse.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryResponse.java index f316606dcb9a9..3a9bbf9da8928 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryResponse.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryResponse.java @@ -39,6 +39,11 @@ import java.io.IOException; import java.util.List; +/** + * Response for recovery operations + * + * @opensearch.internal + */ public final class RecoveryResponse extends TransportResponse { final List phase1FileNames; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoverySettings.java b/server/src/main/java/org/opensearch/indices/recovery/RecoverySettings.java index 8d9eab24f6027..60076f1668af8 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoverySettings.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoverySettings.java @@ -44,6 +44,11 @@ import org.opensearch.common.unit.ByteSizeValue; import org.opensearch.common.unit.TimeValue; +/** + * Settings for the recovery mechanism + * + * @opensearch.internal + */ public class RecoverySettings { private static final Logger logger = LogManager.getLogger(RecoverySettings.class); 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 77596f50a8a5e..fdbdbf4c688e2 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoverySourceHandler.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoverySourceHandler.java @@ -115,6 +115,8 @@ * while the {@link RateLimiter} passed via {@link RecoverySettings} is shared across recoveries * originating from this nodes to throttle the number bytes send during file transfer. The transaction log * phase bypasses the rate limiter entirely. + * + * @opensearch.internal */ public class RecoverySourceHandler { 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 9f57a0ebd4d0f..1d809c2d55415 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryState.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryState.java @@ -63,6 +63,8 @@ /** * Keeps track of state related to shard recovery. + * + * @opensearch.internal */ public class RecoveryState implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTarget.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTarget.java index 6dbbf21eb9360..83c2b03fa19e0 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTarget.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTarget.java @@ -71,6 +71,8 @@ /** * Represents a recovery where the current node is the target node of the recovery. To track recoveries in a central place, instances of * this class are created through {@link RecoveriesCollection}. + * + * @opensearch.internal */ public class RecoveryTarget extends AbstractRefCounted implements RecoveryTargetHandler { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTargetHandler.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTargetHandler.java index 1acef9a8592e4..84b6ec170d3f7 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTargetHandler.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTargetHandler.java @@ -41,6 +41,11 @@ import java.util.List; +/** + * Handler for the recovery target + * + * @opensearch.internal + */ public interface RecoveryTargetHandler { /** diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsRequest.java index 94ac53f77a1d1..eacfb87ecc732 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsRequest.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.List; +/** + * Request for recovery translog operations + * + * @opensearch.internal + */ public class RecoveryTranslogOperationsRequest extends RecoveryTransportRequest { private final long recoveryId; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsResponse.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsResponse.java index da2f224501816..b4ea8bd3e89b6 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsResponse.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTranslogOperationsResponse.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Response for recovery translog operations + * + * @opensearch.internal + */ final class RecoveryTranslogOperationsResponse extends TransportResponse { final long localCheckpoint; diff --git a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTransportRequest.java b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTransportRequest.java index 0ebc8c3d8550d..b48fe4003e18a 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RecoveryTransportRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RecoveryTransportRequest.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Transport request for recovery + * + * @opensearch.internal + */ public abstract class RecoveryTransportRequest extends TransportRequest { private final long requestSeqNo; diff --git a/server/src/main/java/org/opensearch/indices/recovery/ReestablishRecoveryRequest.java b/server/src/main/java/org/opensearch/indices/recovery/ReestablishRecoveryRequest.java index bbf3f19ceb563..179e16f5f0cf6 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/ReestablishRecoveryRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/ReestablishRecoveryRequest.java @@ -41,6 +41,8 @@ /** * Represents a request for starting a peer recovery. + * + * @opensearch.internal */ public class ReestablishRecoveryRequest extends TransportRequest { diff --git a/server/src/main/java/org/opensearch/indices/recovery/RemoteRecoveryTargetHandler.java b/server/src/main/java/org/opensearch/indices/recovery/RemoteRecoveryTargetHandler.java index 35727baa83939..fd6de6322bb0a 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/RemoteRecoveryTargetHandler.java +++ b/server/src/main/java/org/opensearch/indices/recovery/RemoteRecoveryTargetHandler.java @@ -70,6 +70,11 @@ import java.util.concurrent.atomic.AtomicLong; import java.util.function.Consumer; +/** + * Target handler for remote recovery + * + * @opensearch.internal + */ public class RemoteRecoveryTargetHandler implements RecoveryTargetHandler { private static final Logger logger = LogManager.getLogger(RemoteRecoveryTargetHandler.class); diff --git a/server/src/main/java/org/opensearch/indices/recovery/StartRecoveryRequest.java b/server/src/main/java/org/opensearch/indices/recovery/StartRecoveryRequest.java index f2efae2fbe798..24e6504cde59d 100644 --- a/server/src/main/java/org/opensearch/indices/recovery/StartRecoveryRequest.java +++ b/server/src/main/java/org/opensearch/indices/recovery/StartRecoveryRequest.java @@ -44,6 +44,8 @@ /** * Represents a request for starting a peer recovery. + * + * @opensearch.internal */ public class StartRecoveryRequest extends TransportRequest { diff --git a/server/src/main/java/org/opensearch/indices/replication/common/ReplicationTimer.java b/server/src/main/java/org/opensearch/indices/replication/common/ReplicationTimer.java index 976df28265d9a..eeb0ba8bb2c00 100644 --- a/server/src/main/java/org/opensearch/indices/replication/common/ReplicationTimer.java +++ b/server/src/main/java/org/opensearch/indices/replication/common/ReplicationTimer.java @@ -18,6 +18,8 @@ /** * A serializable timer that is used to measure the time taken for * file replication operations like recovery. + * + * @opensearch.internal */ public class ReplicationTimer implements Writeable { private long startTime = 0; diff --git a/server/src/main/java/org/opensearch/indices/replication/common/ReplicationType.java b/server/src/main/java/org/opensearch/indices/replication/common/ReplicationType.java index 98d68d67ba5e3..ac4840e390c0b 100644 --- a/server/src/main/java/org/opensearch/indices/replication/common/ReplicationType.java +++ b/server/src/main/java/org/opensearch/indices/replication/common/ReplicationType.java @@ -11,6 +11,8 @@ /** * Enumerates the types of replication strategies supported by OpenSearch. * For more information, see https://github.com/opensearch-project/OpenSearch/issues/1694 + * + * @opensearch.internal */ public enum ReplicationType { 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 ef10bae987bb1..11442632246b6 100644 --- a/server/src/main/java/org/opensearch/indices/store/IndicesStore.java +++ b/server/src/main/java/org/opensearch/indices/store/IndicesStore.java @@ -83,6 +83,11 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicInteger; +/** + * Store for multiple indexes + * + * @opensearch.internal + */ public class IndicesStore implements ClusterStateListener, Closeable { private static final Logger logger = LogManager.getLogger(IndicesStore.class);