From d047ee34fcb0b6e05daee15a43c5593f806a99ec Mon Sep 17 00:00:00 2001 From: Nicholas Walter Knize Date: Wed, 4 May 2022 14:29:45 -0500 Subject: [PATCH] [Javadocs] add to o.o.monitor,persistance,plugins,repo,script,threadpool,usage,watcher Adds javadocs to classes in the org.opensearch.monitor, persistence, plugins, repository, script, threadpool, usage, and watcher packages. Signed-off-by: Nicholas Walter Knize --- server/src/main/java/org/opensearch/Assertions.java | 2 ++ server/src/main/java/org/opensearch/Build.java | 2 ++ .../src/main/java/org/opensearch/ExceptionsHelper.java | 5 +++++ server/src/main/java/org/opensearch/LegacyESVersion.java | 2 ++ .../org/opensearch/OpenSearchCorruptionException.java | 2 ++ .../main/java/org/opensearch/OpenSearchException.java | 2 ++ .../org/opensearch/OpenSearchGenerationException.java | 2 +- .../java/org/opensearch/OpenSearchParseException.java | 2 ++ .../java/org/opensearch/OpenSearchSecurityException.java | 2 ++ .../java/org/opensearch/OpenSearchStatusException.java | 2 ++ .../java/org/opensearch/OpenSearchTimeoutException.java | 2 +- .../java/org/opensearch/OpenSearchWrapperException.java | 2 ++ .../org/opensearch/ResourceAlreadyExistsException.java | 5 +++++ .../java/org/opensearch/ResourceNotFoundException.java | 2 ++ .../src/main/java/org/opensearch/SpecialPermission.java | 2 ++ server/src/main/java/org/opensearch/Version.java | 5 +++++ .../main/java/org/opensearch/monitor/MonitorService.java | 5 +++++ .../java/org/opensearch/monitor/NodeHealthService.java | 5 +++++ server/src/main/java/org/opensearch/monitor/Probes.java | 5 +++++ .../src/main/java/org/opensearch/monitor/StatusInfo.java | 2 ++ .../java/org/opensearch/monitor/fs/FsHealthService.java | 2 ++ .../src/main/java/org/opensearch/monitor/fs/FsInfo.java | 5 +++++ .../src/main/java/org/opensearch/monitor/fs/FsProbe.java | 5 +++++ .../main/java/org/opensearch/monitor/fs/FsService.java | 5 +++++ .../org/opensearch/monitor/jvm/DeadlockAnalyzer.java | 5 +++++ .../main/java/org/opensearch/monitor/jvm/GcNames.java | 5 +++++ .../main/java/org/opensearch/monitor/jvm/HotThreads.java | 5 +++++ .../org/opensearch/monitor/jvm/JvmGcMonitorService.java | 5 +++++ .../main/java/org/opensearch/monitor/jvm/JvmInfo.java | 5 +++++ .../src/main/java/org/opensearch/monitor/jvm/JvmPid.java | 5 +++++ .../main/java/org/opensearch/monitor/jvm/JvmService.java | 5 +++++ .../main/java/org/opensearch/monitor/jvm/JvmStats.java | 5 +++++ .../src/main/java/org/opensearch/monitor/os/OsInfo.java | 5 +++++ .../src/main/java/org/opensearch/monitor/os/OsProbe.java | 2 ++ .../main/java/org/opensearch/monitor/os/OsService.java | 5 +++++ .../src/main/java/org/opensearch/monitor/os/OsStats.java | 5 +++++ .../java/org/opensearch/monitor/process/ProcessInfo.java | 5 +++++ .../org/opensearch/monitor/process/ProcessProbe.java | 5 +++++ .../org/opensearch/monitor/process/ProcessService.java | 5 +++++ .../org/opensearch/monitor/process/ProcessStats.java | 5 +++++ .../opensearch/persistent/AllocatedPersistentTask.java | 2 ++ .../persistent/CompletionPersistentTaskAction.java | 2 ++ .../persistent/NodePersistentTasksExecutor.java | 2 ++ .../org/opensearch/persistent/PersistentTaskParams.java | 2 ++ .../opensearch/persistent/PersistentTaskResponse.java | 2 ++ .../org/opensearch/persistent/PersistentTaskState.java | 2 ++ .../persistent/PersistentTasksClusterService.java | 2 ++ .../persistent/PersistentTasksCustomMetadata.java | 2 ++ .../opensearch/persistent/PersistentTasksExecutor.java | 2 ++ .../persistent/PersistentTasksExecutorRegistry.java | 2 ++ .../persistent/PersistentTasksNodeService.java | 2 ++ .../opensearch/persistent/PersistentTasksService.java | 2 ++ .../persistent/RemovePersistentTaskAction.java | 5 +++++ .../opensearch/persistent/StartPersistentTaskAction.java | 2 ++ .../persistent/UpdatePersistentTaskStatusAction.java | 5 +++++ .../persistent/decider/AssignmentDecision.java | 2 ++ .../persistent/decider/EnableAssignmentDecider.java | 2 ++ .../main/java/org/opensearch/plugins/ActionPlugin.java | 2 ++ .../main/java/org/opensearch/plugins/AnalysisPlugin.java | 2 ++ .../org/opensearch/plugins/CircuitBreakerPlugin.java | 2 ++ .../main/java/org/opensearch/plugins/ClusterPlugin.java | 2 ++ .../java/org/opensearch/plugins/DiscoveryPlugin.java | 2 ++ .../main/java/org/opensearch/plugins/EnginePlugin.java | 2 ++ .../java/org/opensearch/plugins/ExtensiblePlugin.java | 2 ++ .../java/org/opensearch/plugins/IndexStorePlugin.java | 2 ++ .../main/java/org/opensearch/plugins/IngestPlugin.java | 2 ++ .../main/java/org/opensearch/plugins/MapperPlugin.java | 2 ++ .../java/org/opensearch/plugins/MetadataUpgrader.java | 2 ++ .../main/java/org/opensearch/plugins/NetworkPlugin.java | 2 ++ .../org/opensearch/plugins/PersistentTaskPlugin.java | 2 ++ .../src/main/java/org/opensearch/plugins/Platforms.java | 2 ++ server/src/main/java/org/opensearch/plugins/Plugin.java | 2 ++ .../src/main/java/org/opensearch/plugins/PluginInfo.java | 2 ++ .../org/opensearch/plugins/PluginLoaderIndirection.java | 2 ++ .../main/java/org/opensearch/plugins/PluginSecurity.java | 5 +++++ .../java/org/opensearch/plugins/ReloadablePlugin.java | 2 ++ .../java/org/opensearch/plugins/RepositoryPlugin.java | 2 ++ .../main/java/org/opensearch/plugins/ScriptPlugin.java | 2 ++ .../main/java/org/opensearch/plugins/SearchPlugin.java | 2 ++ .../java/org/opensearch/plugins/SystemIndexPlugin.java | 2 ++ .../opensearch/plugins/spi/NamedXContentProvider.java | 2 ++ .../org/opensearch/repositories/FilterRepository.java | 5 +++++ .../main/java/org/opensearch/repositories/IndexId.java | 2 ++ .../repositories/IndexMetaDataGenerations.java | 2 ++ .../org/opensearch/repositories/RepositoriesModule.java | 2 ++ .../org/opensearch/repositories/RepositoriesService.java | 2 ++ .../repositories/RepositoriesStatsArchive.java | 5 +++++ .../java/org/opensearch/repositories/Repository.java | 2 ++ .../opensearch/repositories/RepositoryCleanupResult.java | 5 +++++ .../java/org/opensearch/repositories/RepositoryData.java | 2 ++ .../org/opensearch/repositories/RepositoryException.java | 2 ++ .../java/org/opensearch/repositories/RepositoryInfo.java | 5 +++++ .../repositories/RepositoryMissingException.java | 2 ++ .../org/opensearch/repositories/RepositoryOperation.java | 2 ++ .../org/opensearch/repositories/RepositoryShardId.java | 2 ++ .../org/opensearch/repositories/RepositoryStats.java | 5 +++++ .../opensearch/repositories/RepositoryStatsSnapshot.java | 5 +++++ .../repositories/RepositoryVerificationException.java | 2 ++ .../org/opensearch/repositories/ShardGenerations.java | 5 +++++ .../org/opensearch/repositories/VerificationFailure.java | 5 +++++ .../repositories/VerifyNodeRepositoryAction.java | 5 +++++ .../repositories/blobstore/BlobStoreRepository.java | 2 ++ .../repositories/blobstore/ChecksumBlobStoreFormat.java | 2 ++ .../repositories/blobstore/FileRestoreContext.java | 2 ++ .../blobstore/MeteredBlobStoreRepository.java | 5 +++++ .../org/opensearch/repositories/fs/FsRepository.java | 2 ++ .../java/org/opensearch/script/AggregationScript.java | 5 +++++ .../org/opensearch/script/BucketAggregationScript.java | 2 ++ .../script/BucketAggregationSelectorScript.java | 2 ++ .../main/java/org/opensearch/script/ClassPermission.java | 2 ++ .../src/main/java/org/opensearch/script/DynamicMap.java | 2 ++ .../org/opensearch/script/ExplainableScoreScript.java | 2 ++ .../src/main/java/org/opensearch/script/FieldScript.java | 2 ++ .../main/java/org/opensearch/script/FilterScript.java | 2 ++ .../org/opensearch/script/GeneralScriptException.java | 2 ++ .../org/opensearch/script/IngestConditionalScript.java | 2 ++ .../main/java/org/opensearch/script/IngestScript.java | 2 ++ .../opensearch/script/JodaCompatibleZonedDateTime.java | 2 ++ .../java/org/opensearch/script/NumberSortScript.java | 5 +++++ .../src/main/java/org/opensearch/script/ScoreScript.java | 2 ++ .../java/org/opensearch/script/ScoreScriptUtils.java | 5 +++++ server/src/main/java/org/opensearch/script/Script.java | 2 ++ .../src/main/java/org/opensearch/script/ScriptCache.java | 2 ++ .../java/org/opensearch/script/ScriptCacheStats.java | 9 ++++++++- .../main/java/org/opensearch/script/ScriptContext.java | 2 ++ .../java/org/opensearch/script/ScriptContextInfo.java | 5 +++++ .../java/org/opensearch/script/ScriptContextStats.java | 5 +++++ .../main/java/org/opensearch/script/ScriptEngine.java | 2 ++ .../main/java/org/opensearch/script/ScriptException.java | 2 ++ .../main/java/org/opensearch/script/ScriptFactory.java | 2 ++ .../java/org/opensearch/script/ScriptLanguagesInfo.java | 2 ++ .../main/java/org/opensearch/script/ScriptMetadata.java | 2 ++ .../main/java/org/opensearch/script/ScriptMetrics.java | 5 +++++ .../main/java/org/opensearch/script/ScriptModule.java | 2 ++ .../main/java/org/opensearch/script/ScriptService.java | 5 +++++ .../src/main/java/org/opensearch/script/ScriptStats.java | 5 +++++ .../src/main/java/org/opensearch/script/ScriptType.java | 2 ++ .../org/opensearch/script/ScriptedMetricAggContexts.java | 5 +++++ .../script/SignificantTermsHeuristicScoreScript.java | 2 ++ .../java/org/opensearch/script/SimilarityScript.java | 6 +++++- .../org/opensearch/script/SimilarityWeightScript.java | 6 +++++- .../java/org/opensearch/script/StoredScriptSource.java | 2 ++ .../java/org/opensearch/script/StringSortScript.java | 5 +++++ .../main/java/org/opensearch/script/TemplateScript.java | 2 ++ .../java/org/opensearch/script/TermsSetQueryScript.java | 5 +++++ .../main/java/org/opensearch/script/UpdateScript.java | 2 ++ .../threadpool/AutoQueueAdjustingExecutorBuilder.java | 2 ++ .../org/opensearch/threadpool/CancellableAdapter.java | 5 +++++ .../java/org/opensearch/threadpool/ExecutorBuilder.java | 2 ++ .../org/opensearch/threadpool/FixedExecutorBuilder.java | 2 ++ .../opensearch/threadpool/ScalingExecutorBuilder.java | 2 ++ .../threadpool/ScheduledCancellableAdapter.java | 5 +++++ .../main/java/org/opensearch/threadpool/Scheduler.java | 2 ++ .../main/java/org/opensearch/threadpool/ThreadPool.java | 5 +++++ .../java/org/opensearch/threadpool/ThreadPoolInfo.java | 5 +++++ .../java/org/opensearch/threadpool/ThreadPoolStats.java | 5 +++++ .../src/main/java/org/opensearch/usage/UsageService.java | 2 ++ .../org/opensearch/watcher/AbstractResourceWatcher.java | 2 ++ .../java/org/opensearch/watcher/FileChangesListener.java | 2 ++ .../main/java/org/opensearch/watcher/FileWatcher.java | 2 ++ .../java/org/opensearch/watcher/ResourceWatcher.java | 2 ++ .../org/opensearch/watcher/ResourceWatcherService.java | 2 ++ .../main/java/org/opensearch/watcher/WatcherHandle.java | 5 +++++ 163 files changed, 498 insertions(+), 5 deletions(-) diff --git a/server/src/main/java/org/opensearch/Assertions.java b/server/src/main/java/org/opensearch/Assertions.java index 6873364f7987d..843853ec8b20b 100644 --- a/server/src/main/java/org/opensearch/Assertions.java +++ b/server/src/main/java/org/opensearch/Assertions.java @@ -36,6 +36,8 @@ * Provides a static final field that can be used to check if assertions are enabled. Since this field might be used elsewhere to check if * assertions are enabled, if you are running with assertions enabled for specific packages or classes, you should enable assertions on this * class too (e.g., {@code -ea org.opensearch.Assertions -ea org.opensearch.cluster.service.MasterService}). + * + * @opensearch.internal */ public final class Assertions { diff --git a/server/src/main/java/org/opensearch/Build.java b/server/src/main/java/org/opensearch/Build.java index 9508a63de5991..1d21de6863eef 100644 --- a/server/src/main/java/org/opensearch/Build.java +++ b/server/src/main/java/org/opensearch/Build.java @@ -46,6 +46,8 @@ /** * Information about a build of OpenSearch. + * + * @opensearch.internal */ public class Build { /** diff --git a/server/src/main/java/org/opensearch/ExceptionsHelper.java b/server/src/main/java/org/opensearch/ExceptionsHelper.java index 418bf9811a7b3..f252d0b05af79 100644 --- a/server/src/main/java/org/opensearch/ExceptionsHelper.java +++ b/server/src/main/java/org/opensearch/ExceptionsHelper.java @@ -61,6 +61,11 @@ import java.util.function.Predicate; import java.util.stream.Collectors; +/** + * Helper class for OpenSearch Exceptions + * + * @opensearch.internal + */ public final class ExceptionsHelper { private static final Logger logger = LogManager.getLogger(ExceptionsHelper.class); diff --git a/server/src/main/java/org/opensearch/LegacyESVersion.java b/server/src/main/java/org/opensearch/LegacyESVersion.java index 38b655b09b151..d4ac3c7d2f8b1 100644 --- a/server/src/main/java/org/opensearch/LegacyESVersion.java +++ b/server/src/main/java/org/opensearch/LegacyESVersion.java @@ -43,6 +43,8 @@ * * This class keeps all the supported OpenSearch predecessor versions for * backward compatibility purpose. + * + * @opensearch.internal */ public class LegacyESVersion extends Version { diff --git a/server/src/main/java/org/opensearch/OpenSearchCorruptionException.java b/server/src/main/java/org/opensearch/OpenSearchCorruptionException.java index ecca2191295a4..eb012b209c7de 100644 --- a/server/src/main/java/org/opensearch/OpenSearchCorruptionException.java +++ b/server/src/main/java/org/opensearch/OpenSearchCorruptionException.java @@ -36,6 +36,8 @@ /** * This exception is thrown when OpenSearch detects * an inconsistency in one of it's persistent files. + * + * @opensearch.internal */ public class OpenSearchCorruptionException extends IOException { diff --git a/server/src/main/java/org/opensearch/OpenSearchException.java b/server/src/main/java/org/opensearch/OpenSearchException.java index 5a9e5b91982a2..a6a12d7ebb4f7 100644 --- a/server/src/main/java/org/opensearch/OpenSearchException.java +++ b/server/src/main/java/org/opensearch/OpenSearchException.java @@ -73,6 +73,8 @@ /** * A base class for all opensearch exceptions. + * + * @opensearch.internal */ public class OpenSearchException extends RuntimeException implements ToXContentFragment, Writeable { diff --git a/server/src/main/java/org/opensearch/OpenSearchGenerationException.java b/server/src/main/java/org/opensearch/OpenSearchGenerationException.java index 1f112aaf5a6e6..23f93263ee3d2 100644 --- a/server/src/main/java/org/opensearch/OpenSearchGenerationException.java +++ b/server/src/main/java/org/opensearch/OpenSearchGenerationException.java @@ -39,7 +39,7 @@ /** * A generic exception indicating failure to generate. * - * + * @opensearch.internal */ public class OpenSearchGenerationException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/OpenSearchParseException.java b/server/src/main/java/org/opensearch/OpenSearchParseException.java index 0cc537f36a3ec..57eab19cc01f4 100644 --- a/server/src/main/java/org/opensearch/OpenSearchParseException.java +++ b/server/src/main/java/org/opensearch/OpenSearchParseException.java @@ -39,6 +39,8 @@ /** * Unchecked exception that is translated into a {@code 400 BAD REQUEST} error when it bubbles out over HTTP. + * + * @opensearch.internal */ public class OpenSearchParseException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/OpenSearchSecurityException.java b/server/src/main/java/org/opensearch/OpenSearchSecurityException.java index 35edb058605a7..6f725573e71ce 100644 --- a/server/src/main/java/org/opensearch/OpenSearchSecurityException.java +++ b/server/src/main/java/org/opensearch/OpenSearchSecurityException.java @@ -38,6 +38,8 @@ /** * Generic security exception + * + * @opensearch.internal */ public class OpenSearchSecurityException extends OpenSearchStatusException { /** diff --git a/server/src/main/java/org/opensearch/OpenSearchStatusException.java b/server/src/main/java/org/opensearch/OpenSearchStatusException.java index 274eac8f8b2ad..b9cc51eaa2a8d 100644 --- a/server/src/main/java/org/opensearch/OpenSearchStatusException.java +++ b/server/src/main/java/org/opensearch/OpenSearchStatusException.java @@ -41,6 +41,8 @@ /** * Exception who's {@link RestStatus} is arbitrary rather than derived. Used, for example, by reindex-from-remote to wrap remote exceptions * that contain a status. + * + * @opensearch.internal */ public class OpenSearchStatusException extends OpenSearchException { private final RestStatus status; diff --git a/server/src/main/java/org/opensearch/OpenSearchTimeoutException.java b/server/src/main/java/org/opensearch/OpenSearchTimeoutException.java index 6b20e145e500b..6f97d8fc3dde3 100644 --- a/server/src/main/java/org/opensearch/OpenSearchTimeoutException.java +++ b/server/src/main/java/org/opensearch/OpenSearchTimeoutException.java @@ -39,7 +39,7 @@ /** * The same as {@link java.util.concurrent.TimeoutException} simply a runtime one. * - * + * @opensearch.internal */ public class OpenSearchTimeoutException extends OpenSearchException { public OpenSearchTimeoutException(StreamInput in) throws IOException { diff --git a/server/src/main/java/org/opensearch/OpenSearchWrapperException.java b/server/src/main/java/org/opensearch/OpenSearchWrapperException.java index aa3e857f96901..3ef5ec4feac2d 100644 --- a/server/src/main/java/org/opensearch/OpenSearchWrapperException.java +++ b/server/src/main/java/org/opensearch/OpenSearchWrapperException.java @@ -36,6 +36,8 @@ * An exception that is meant to be "unwrapped" when sent back to the user * as an error because its is {@link #getCause() cause}, if non-null is * always more useful to the user than the exception itself. + * + * @opensearch.internal */ public interface OpenSearchWrapperException { Throwable getCause(); diff --git a/server/src/main/java/org/opensearch/ResourceAlreadyExistsException.java b/server/src/main/java/org/opensearch/ResourceAlreadyExistsException.java index e6b5177538fa9..2fbbf459ea293 100644 --- a/server/src/main/java/org/opensearch/ResourceAlreadyExistsException.java +++ b/server/src/main/java/org/opensearch/ResourceAlreadyExistsException.java @@ -38,6 +38,11 @@ import java.io.IOException; +/** + * Exception when Resources already exists + * + * @opensearch.internal + */ public class ResourceAlreadyExistsException extends OpenSearchException { public ResourceAlreadyExistsException(Index index) { diff --git a/server/src/main/java/org/opensearch/ResourceNotFoundException.java b/server/src/main/java/org/opensearch/ResourceNotFoundException.java index 373493aeb53b1..6282f9f03b4f9 100644 --- a/server/src/main/java/org/opensearch/ResourceNotFoundException.java +++ b/server/src/main/java/org/opensearch/ResourceNotFoundException.java @@ -38,6 +38,8 @@ /** * Generic ResourceNotFoundException corresponding to the {@link RestStatus#NOT_FOUND} status code + * + * @opensearch.internal */ public class ResourceNotFoundException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/SpecialPermission.java b/server/src/main/java/org/opensearch/SpecialPermission.java index 00ae1528d4ef2..8a694d4543f32 100644 --- a/server/src/main/java/org/opensearch/SpecialPermission.java +++ b/server/src/main/java/org/opensearch/SpecialPermission.java @@ -68,6 +68,8 @@ * ... * ); * + * + * @opensearch.internal */ public final class SpecialPermission extends BasicPermission { diff --git a/server/src/main/java/org/opensearch/Version.java b/server/src/main/java/org/opensearch/Version.java index ad3546b2498f2..d3dc62b6b6f35 100644 --- a/server/src/main/java/org/opensearch/Version.java +++ b/server/src/main/java/org/opensearch/Version.java @@ -51,6 +51,11 @@ import java.util.Locale; import java.util.Objects; +/** + * OpenSearch Version Class + * + * @opensearch.api + */ public class Version implements Comparable, ToXContentFragment { /* * The logic for ID is: XXYYZZAA, where XX is major version, YY is minor version, ZZ is revision, and AA is alpha/beta/rc indicator AA diff --git a/server/src/main/java/org/opensearch/monitor/MonitorService.java b/server/src/main/java/org/opensearch/monitor/MonitorService.java index 85a96a16ab912..0e24eb094cd4d 100644 --- a/server/src/main/java/org/opensearch/monitor/MonitorService.java +++ b/server/src/main/java/org/opensearch/monitor/MonitorService.java @@ -44,6 +44,11 @@ import java.io.IOException; +/** + * The resource monitoring service + * + * @opensearch.internal + */ public class MonitorService extends AbstractLifecycleComponent { private final JvmGcMonitorService jvmGcMonitorService; diff --git a/server/src/main/java/org/opensearch/monitor/NodeHealthService.java b/server/src/main/java/org/opensearch/monitor/NodeHealthService.java index e9e8cf33dcbd5..54d64e8c83b28 100644 --- a/server/src/main/java/org/opensearch/monitor/NodeHealthService.java +++ b/server/src/main/java/org/opensearch/monitor/NodeHealthService.java @@ -32,6 +32,11 @@ package org.opensearch.monitor; +/** + * The service for monitoring node health + * + * @opensearch.internal + */ @FunctionalInterface public interface NodeHealthService { diff --git a/server/src/main/java/org/opensearch/monitor/Probes.java b/server/src/main/java/org/opensearch/monitor/Probes.java index 12f0e67be32c5..08f9eb7c2c376 100644 --- a/server/src/main/java/org/opensearch/monitor/Probes.java +++ b/server/src/main/java/org/opensearch/monitor/Probes.java @@ -35,6 +35,11 @@ import java.lang.management.OperatingSystemMXBean; import java.lang.reflect.Method; +/** + * Probes the various resources + * + * @opensearch.internal + */ public class Probes { public static short getLoadAndScaleToPercent(Method method, OperatingSystemMXBean osMxBean) { if (method != null) { diff --git a/server/src/main/java/org/opensearch/monitor/StatusInfo.java b/server/src/main/java/org/opensearch/monitor/StatusInfo.java index b1d8528e8822f..fdb8bc9469b6a 100644 --- a/server/src/main/java/org/opensearch/monitor/StatusInfo.java +++ b/server/src/main/java/org/opensearch/monitor/StatusInfo.java @@ -35,6 +35,8 @@ /** * Class that represents the Health status for a node as determined by {@link NodeHealthService} and provides additional * info explaining the reasons + * + * @opensearch.internal */ public class StatusInfo { diff --git a/server/src/main/java/org/opensearch/monitor/fs/FsHealthService.java b/server/src/main/java/org/opensearch/monitor/fs/FsHealthService.java index a1f526a3a1bd8..5863f3396b2ce 100644 --- a/server/src/main/java/org/opensearch/monitor/fs/FsHealthService.java +++ b/server/src/main/java/org/opensearch/monitor/fs/FsHealthService.java @@ -68,6 +68,8 @@ /** * Runs periodically and attempts to create a temp file to see if the filesystem is writable. If not then it marks the * path as unhealthy. + * + * @opensearch.internal */ public class FsHealthService extends AbstractLifecycleComponent implements NodeHealthService { diff --git a/server/src/main/java/org/opensearch/monitor/fs/FsInfo.java b/server/src/main/java/org/opensearch/monitor/fs/FsInfo.java index 5a17cb05ef225..f28bdbfa916a2 100644 --- a/server/src/main/java/org/opensearch/monitor/fs/FsInfo.java +++ b/server/src/main/java/org/opensearch/monitor/fs/FsInfo.java @@ -49,6 +49,11 @@ import java.util.Iterator; import java.util.Set; +/** + * FileSystem information + * + * @opensearch.internal + */ public class FsInfo implements Iterable, Writeable, ToXContentFragment { public static class Path implements Writeable, ToXContentObject { diff --git a/server/src/main/java/org/opensearch/monitor/fs/FsProbe.java b/server/src/main/java/org/opensearch/monitor/fs/FsProbe.java index 7fd5c66895db6..37cfee62bee27 100644 --- a/server/src/main/java/org/opensearch/monitor/fs/FsProbe.java +++ b/server/src/main/java/org/opensearch/monitor/fs/FsProbe.java @@ -51,6 +51,11 @@ import java.util.Map; import java.util.Set; +/** + * FileSystem probe + * + * @opensearch.internal + */ public class FsProbe { private static final Logger logger = LogManager.getLogger(FsProbe.class); diff --git a/server/src/main/java/org/opensearch/monitor/fs/FsService.java b/server/src/main/java/org/opensearch/monitor/fs/FsService.java index 837b7dbbe4fa2..728a6d7f0b36d 100644 --- a/server/src/main/java/org/opensearch/monitor/fs/FsService.java +++ b/server/src/main/java/org/opensearch/monitor/fs/FsService.java @@ -44,6 +44,11 @@ import java.io.IOException; import java.util.function.Supplier; +/** + * FileSystem service + * + * @opensearch.internal + */ public class FsService { private static final Logger logger = LogManager.getLogger(FsService.class); diff --git a/server/src/main/java/org/opensearch/monitor/jvm/DeadlockAnalyzer.java b/server/src/main/java/org/opensearch/monitor/jvm/DeadlockAnalyzer.java index 22705d8d163b8..6751c52a0a536 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/DeadlockAnalyzer.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/DeadlockAnalyzer.java @@ -45,6 +45,11 @@ import static java.util.Collections.unmodifiableMap; import static java.util.Collections.unmodifiableSet; +/** + * Analyzes Operating System deadlocks + * + * @opensearch.internal + */ public class DeadlockAnalyzer { private static final Deadlock NULL_RESULT[] = new Deadlock[0]; diff --git a/server/src/main/java/org/opensearch/monitor/jvm/GcNames.java b/server/src/main/java/org/opensearch/monitor/jvm/GcNames.java index 3b464314b7ceb..d6b77186e021c 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/GcNames.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/GcNames.java @@ -32,6 +32,11 @@ package org.opensearch.monitor.jvm; +/** + * Simple utility class for human readable GC names + * + * @opensearch.internal + */ public class GcNames { public static final String YOUNG = "young"; diff --git a/server/src/main/java/org/opensearch/monitor/jvm/HotThreads.java b/server/src/main/java/org/opensearch/monitor/jvm/HotThreads.java index 8e91a7258aabd..b5963d8ebd889 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/HotThreads.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/HotThreads.java @@ -51,6 +51,11 @@ import java.util.concurrent.TimeUnit; import java.util.function.ToLongFunction; +/** + * Monitors hot threads + * + * @opensearch.internal + */ public class HotThreads { private static final Object mutex = new Object(); diff --git a/server/src/main/java/org/opensearch/monitor/jvm/JvmGcMonitorService.java b/server/src/main/java/org/opensearch/monitor/jvm/JvmGcMonitorService.java index 5020cbec36e44..7bdc74d9ae574 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/JvmGcMonitorService.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/JvmGcMonitorService.java @@ -54,6 +54,11 @@ import static java.util.Collections.unmodifiableMap; +/** + * Service to monitor garbage collection + * + * @opensearch.internal + */ public class JvmGcMonitorService extends AbstractLifecycleComponent { private static final Logger logger = LogManager.getLogger(JvmGcMonitorService.class); diff --git a/server/src/main/java/org/opensearch/monitor/jvm/JvmInfo.java b/server/src/main/java/org/opensearch/monitor/jvm/JvmInfo.java index ed6d21869acd7..31f597ebebcc8 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/JvmInfo.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/JvmInfo.java @@ -57,6 +57,11 @@ import java.util.List; import java.util.Map; +/** + * Holds information about the JVM + * + * @opensearch.internal + */ public class JvmInfo implements ReportingService.Info { private static JvmInfo INSTANCE; diff --git a/server/src/main/java/org/opensearch/monitor/jvm/JvmPid.java b/server/src/main/java/org/opensearch/monitor/jvm/JvmPid.java index 9a2fbfbd27c68..928257af71aa5 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/JvmPid.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/JvmPid.java @@ -32,6 +32,11 @@ package org.opensearch.monitor.jvm; +/** + * JVM Process ID + * + * @opensearch.internal + */ class JvmPid { static long getPid() { diff --git a/server/src/main/java/org/opensearch/monitor/jvm/JvmService.java b/server/src/main/java/org/opensearch/monitor/jvm/JvmService.java index edf8e47317114..d59120063e338 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/JvmService.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/JvmService.java @@ -40,6 +40,11 @@ import org.opensearch.common.unit.TimeValue; import org.opensearch.node.ReportingService; +/** + * Service for monitoring the JVM + * + * @opensearch.internal + */ public class JvmService implements ReportingService { private static final Logger logger = LogManager.getLogger(JvmService.class); diff --git a/server/src/main/java/org/opensearch/monitor/jvm/JvmStats.java b/server/src/main/java/org/opensearch/monitor/jvm/JvmStats.java index e8fa037f3a4d7..0924adb4e8114 100644 --- a/server/src/main/java/org/opensearch/monitor/jvm/JvmStats.java +++ b/server/src/main/java/org/opensearch/monitor/jvm/JvmStats.java @@ -58,6 +58,11 @@ import java.util.List; import java.util.concurrent.TimeUnit; +/** + * Holds JVM statistics + * + * @opensearch.internal + */ public class JvmStats implements Writeable, ToXContentFragment { private static final RuntimeMXBean runtimeMXBean; diff --git a/server/src/main/java/org/opensearch/monitor/os/OsInfo.java b/server/src/main/java/org/opensearch/monitor/os/OsInfo.java index 2dacb88b4b254..5f683778349c6 100644 --- a/server/src/main/java/org/opensearch/monitor/os/OsInfo.java +++ b/server/src/main/java/org/opensearch/monitor/os/OsInfo.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Holds Operating System Information + * + * @opensearch.internal + */ public class OsInfo implements ReportingService.Info { private final long refreshInterval; diff --git a/server/src/main/java/org/opensearch/monitor/os/OsProbe.java b/server/src/main/java/org/opensearch/monitor/os/OsProbe.java index eda86c49539dd..98229941252ba 100644 --- a/server/src/main/java/org/opensearch/monitor/os/OsProbe.java +++ b/server/src/main/java/org/opensearch/monitor/os/OsProbe.java @@ -74,6 +74,8 @@ * - An error case retrieving these values from a linux kernel * - A non-standard libc implementation not implementing the required values * For a more exhaustive explanation, see https://github.com/elastic/elasticsearch/pull/42725 + * + * @opensearch.internal */ public class OsProbe { diff --git a/server/src/main/java/org/opensearch/monitor/os/OsService.java b/server/src/main/java/org/opensearch/monitor/os/OsService.java index 344a5ccf5f849..00e4bb1365b71 100644 --- a/server/src/main/java/org/opensearch/monitor/os/OsService.java +++ b/server/src/main/java/org/opensearch/monitor/os/OsService.java @@ -44,6 +44,11 @@ import java.io.IOException; +/** + * Service for the Operating System + * + * @opensearch.internal + */ public class OsService implements ReportingService { private static final Logger logger = LogManager.getLogger(OsService.class); diff --git a/server/src/main/java/org/opensearch/monitor/os/OsStats.java b/server/src/main/java/org/opensearch/monitor/os/OsStats.java index cc9dec8d2727b..e05fb56ba5570 100644 --- a/server/src/main/java/org/opensearch/monitor/os/OsStats.java +++ b/server/src/main/java/org/opensearch/monitor/os/OsStats.java @@ -45,6 +45,11 @@ import java.util.Arrays; import java.util.Objects; +/** + * Holds stats for the Operating System + * + * @opensearch.internal + */ public class OsStats implements Writeable, ToXContentFragment { private final long timestamp; diff --git a/server/src/main/java/org/opensearch/monitor/process/ProcessInfo.java b/server/src/main/java/org/opensearch/monitor/process/ProcessInfo.java index 073309b61926a..1ddf7b74e0d1c 100644 --- a/server/src/main/java/org/opensearch/monitor/process/ProcessInfo.java +++ b/server/src/main/java/org/opensearch/monitor/process/ProcessInfo.java @@ -40,6 +40,11 @@ import java.io.IOException; +/** + * Holds information for monitoring the process + * + * @opensearch.internal + */ public class ProcessInfo implements ReportingService.Info { private final long refreshInterval; diff --git a/server/src/main/java/org/opensearch/monitor/process/ProcessProbe.java b/server/src/main/java/org/opensearch/monitor/process/ProcessProbe.java index 09faae6bcaefa..c2f83003d2c04 100644 --- a/server/src/main/java/org/opensearch/monitor/process/ProcessProbe.java +++ b/server/src/main/java/org/opensearch/monitor/process/ProcessProbe.java @@ -41,6 +41,11 @@ import static org.opensearch.monitor.jvm.JvmInfo.jvmInfo; +/** + * Probes the process + * + * @opensearch.internal + */ public class ProcessProbe { private static final OperatingSystemMXBean osMxBean = ManagementFactory.getOperatingSystemMXBean(); diff --git a/server/src/main/java/org/opensearch/monitor/process/ProcessService.java b/server/src/main/java/org/opensearch/monitor/process/ProcessService.java index c60d4435b46b0..538f546bd98ee 100644 --- a/server/src/main/java/org/opensearch/monitor/process/ProcessService.java +++ b/server/src/main/java/org/opensearch/monitor/process/ProcessService.java @@ -41,6 +41,11 @@ import org.opensearch.common.util.SingleObjectCache; import org.opensearch.node.ReportingService; +/** + * The service for the process + * + * @opensearch.internal + */ public final class ProcessService implements ReportingService { private static final Logger logger = LogManager.getLogger(ProcessService.class); diff --git a/server/src/main/java/org/opensearch/monitor/process/ProcessStats.java b/server/src/main/java/org/opensearch/monitor/process/ProcessStats.java index 6fce06ac5a93d..e5ed6a4a7d369 100644 --- a/server/src/main/java/org/opensearch/monitor/process/ProcessStats.java +++ b/server/src/main/java/org/opensearch/monitor/process/ProcessStats.java @@ -43,6 +43,11 @@ import java.io.IOException; +/** + * Holds stats for the process + * + * @opensearch.internal + */ public class ProcessStats implements Writeable, ToXContentFragment { private final long timestamp; diff --git a/server/src/main/java/org/opensearch/persistent/AllocatedPersistentTask.java b/server/src/main/java/org/opensearch/persistent/AllocatedPersistentTask.java index 48397a1b1e8df..caede050df5a7 100644 --- a/server/src/main/java/org/opensearch/persistent/AllocatedPersistentTask.java +++ b/server/src/main/java/org/opensearch/persistent/AllocatedPersistentTask.java @@ -48,6 +48,8 @@ /** * Represents a executor node operation that corresponds to a persistent task + * + * @opensearch.internal */ public class AllocatedPersistentTask extends CancellableTask { diff --git a/server/src/main/java/org/opensearch/persistent/CompletionPersistentTaskAction.java b/server/src/main/java/org/opensearch/persistent/CompletionPersistentTaskAction.java index 4aa9b8d7eb781..6ae3150a04019 100644 --- a/server/src/main/java/org/opensearch/persistent/CompletionPersistentTaskAction.java +++ b/server/src/main/java/org/opensearch/persistent/CompletionPersistentTaskAction.java @@ -58,6 +58,8 @@ /** * ActionType that is used by executor node to indicate that the persistent action finished or failed on the node and needs to be * removed from the cluster state in case of successful completion or restarted on some other node in case of failure. + * + * @opensearch.internal */ public class CompletionPersistentTaskAction extends ActionType { diff --git a/server/src/main/java/org/opensearch/persistent/NodePersistentTasksExecutor.java b/server/src/main/java/org/opensearch/persistent/NodePersistentTasksExecutor.java index d62a6dd669a6c..209df1e1f498d 100644 --- a/server/src/main/java/org/opensearch/persistent/NodePersistentTasksExecutor.java +++ b/server/src/main/java/org/opensearch/persistent/NodePersistentTasksExecutor.java @@ -39,6 +39,8 @@ * This component is responsible for execution of persistent tasks. * * It abstracts away the execution of tasks and greatly simplifies testing of PersistentTasksNodeService + * + * @opensearch.internal */ public class NodePersistentTasksExecutor { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTaskParams.java b/server/src/main/java/org/opensearch/persistent/PersistentTaskParams.java index e10d70688a912..a34ed6bf1daf2 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTaskParams.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTaskParams.java @@ -38,6 +38,8 @@ /** * Parameters used to start persistent task + * + * @opensearch.internal */ public interface PersistentTaskParams extends VersionedNamedWriteable, ToXContentObject, ClusterState.FeatureAware { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTaskResponse.java b/server/src/main/java/org/opensearch/persistent/PersistentTaskResponse.java index cc09d3d0b39d7..7abc81d72d698 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTaskResponse.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTaskResponse.java @@ -41,6 +41,8 @@ /** * Response upon a successful start or an persistent task + * + * @opensearch.internal */ public class PersistentTaskResponse extends ActionResponse { private PersistentTask task; diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTaskState.java b/server/src/main/java/org/opensearch/persistent/PersistentTaskState.java index 3b57ce92e8634..a785798dbb5cf 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTaskState.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTaskState.java @@ -37,5 +37,7 @@ /** * {@link PersistentTaskState} represents the state of the persistent tasks, as it * is persisted in the cluster state. + * + * @opensearch.internal */ public interface PersistentTaskState extends ToXContentObject, NamedWriteable {} diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTasksClusterService.java b/server/src/main/java/org/opensearch/persistent/PersistentTasksClusterService.java index e6a9ae673211f..b76fc1b93915e 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTasksClusterService.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTasksClusterService.java @@ -61,6 +61,8 @@ /** * Component that runs only on the cluster-manager node and is responsible for assigning running tasks to nodes + * + * @opensearch.internal */ public class PersistentTasksClusterService implements ClusterStateListener, Closeable { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTasksCustomMetadata.java b/server/src/main/java/org/opensearch/persistent/PersistentTasksCustomMetadata.java index d39e96e9da9e3..ac6536564d8d0 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTasksCustomMetadata.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTasksCustomMetadata.java @@ -71,6 +71,8 @@ /** * A cluster state record that contains a list of all running persistent tasks + * + * @opensearch.internal */ public final class PersistentTasksCustomMetadata extends AbstractNamedDiffable implements Metadata.Custom { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutor.java b/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutor.java index 0c6e3bb590506..08a509af0b307 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutor.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutor.java @@ -45,6 +45,8 @@ /** * An executor of tasks that can survive restart of requesting or executing node. * These tasks are using cluster state rather than only transport service to send requests and responses. + * + * @opensearch.internal */ public abstract class PersistentTasksExecutor { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutorRegistry.java b/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutorRegistry.java index 3f9bd06ead44b..8de183faa0464 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutorRegistry.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTasksExecutorRegistry.java @@ -38,6 +38,8 @@ /** * Components that registers all persistent task executors + * + * @opensearch.internal */ public class PersistentTasksExecutorRegistry { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTasksNodeService.java b/server/src/main/java/org/opensearch/persistent/PersistentTasksNodeService.java index 0a88204c7cfe9..54ffadb96243a 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTasksNodeService.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTasksNodeService.java @@ -61,6 +61,8 @@ /** * This component is responsible for coordination of execution of persistent tasks on individual nodes. It runs on all * nodes in the cluster and monitors cluster state changes to detect started commands. + * + * @opensearch.internal */ public class PersistentTasksNodeService implements ClusterStateListener { diff --git a/server/src/main/java/org/opensearch/persistent/PersistentTasksService.java b/server/src/main/java/org/opensearch/persistent/PersistentTasksService.java index c3d78bb614200..1026be4ad8161 100644 --- a/server/src/main/java/org/opensearch/persistent/PersistentTasksService.java +++ b/server/src/main/java/org/opensearch/persistent/PersistentTasksService.java @@ -56,6 +56,8 @@ * This service is used by persistent tasks and allocated persistent tasks to communicate changes * to the cluster-manager node so that the cluster-manager can update the cluster state and can track of the states * of the persistent tasks. + * + * @opensearch.internal */ public class PersistentTasksService { diff --git a/server/src/main/java/org/opensearch/persistent/RemovePersistentTaskAction.java b/server/src/main/java/org/opensearch/persistent/RemovePersistentTaskAction.java index d35d5fbf70f0a..855e5b0099b29 100644 --- a/server/src/main/java/org/opensearch/persistent/RemovePersistentTaskAction.java +++ b/server/src/main/java/org/opensearch/persistent/RemovePersistentTaskAction.java @@ -53,6 +53,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Transport action to remove a persistent task + * + * @opensearch.internal + */ public class RemovePersistentTaskAction extends ActionType { public static final RemovePersistentTaskAction INSTANCE = new RemovePersistentTaskAction(); diff --git a/server/src/main/java/org/opensearch/persistent/StartPersistentTaskAction.java b/server/src/main/java/org/opensearch/persistent/StartPersistentTaskAction.java index b5d7885f1e313..2bd822d2fab62 100644 --- a/server/src/main/java/org/opensearch/persistent/StartPersistentTaskAction.java +++ b/server/src/main/java/org/opensearch/persistent/StartPersistentTaskAction.java @@ -58,6 +58,8 @@ /** * This action can be used to add the record for the persistent action to the cluster state. + * + * @opensearch.internal */ public class StartPersistentTaskAction extends ActionType { diff --git a/server/src/main/java/org/opensearch/persistent/UpdatePersistentTaskStatusAction.java b/server/src/main/java/org/opensearch/persistent/UpdatePersistentTaskStatusAction.java index b72e8c963dc43..928e51f5a594c 100644 --- a/server/src/main/java/org/opensearch/persistent/UpdatePersistentTaskStatusAction.java +++ b/server/src/main/java/org/opensearch/persistent/UpdatePersistentTaskStatusAction.java @@ -55,6 +55,11 @@ import static org.opensearch.action.ValidateActions.addValidationError; +/** + * Transport action for updating persistent tasks + * + * @opensearch.internal + */ public class UpdatePersistentTaskStatusAction extends ActionType { public static final UpdatePersistentTaskStatusAction INSTANCE = new UpdatePersistentTaskStatusAction(); diff --git a/server/src/main/java/org/opensearch/persistent/decider/AssignmentDecision.java b/server/src/main/java/org/opensearch/persistent/decider/AssignmentDecision.java index 45d4e643f624b..70a03b7710b6f 100644 --- a/server/src/main/java/org/opensearch/persistent/decider/AssignmentDecision.java +++ b/server/src/main/java/org/opensearch/persistent/decider/AssignmentDecision.java @@ -39,6 +39,8 @@ * assigning a persistent task to a node of the cluster. * * @see EnableAssignmentDecider + * + * @opensearch.internal */ public final class AssignmentDecision { diff --git a/server/src/main/java/org/opensearch/persistent/decider/EnableAssignmentDecider.java b/server/src/main/java/org/opensearch/persistent/decider/EnableAssignmentDecider.java index 795fb3b77b9fb..4c306dca758e7 100644 --- a/server/src/main/java/org/opensearch/persistent/decider/EnableAssignmentDecider.java +++ b/server/src/main/java/org/opensearch/persistent/decider/EnableAssignmentDecider.java @@ -51,6 +51,8 @@ * * * @see Allocation + * + * @opensearch.internal */ public class EnableAssignmentDecider { diff --git a/server/src/main/java/org/opensearch/plugins/ActionPlugin.java b/server/src/main/java/org/opensearch/plugins/ActionPlugin.java index e4254fb9acbad..d9792d60ae735 100644 --- a/server/src/main/java/org/opensearch/plugins/ActionPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/ActionPlugin.java @@ -72,6 +72,8 @@ * new ActionHandler<>(RethrottleAction.INSTANCE, TransportRethrottleAction.class)); * } * } + * + * @opensearch.api */ public interface ActionPlugin { /** diff --git a/server/src/main/java/org/opensearch/plugins/AnalysisPlugin.java b/server/src/main/java/org/opensearch/plugins/AnalysisPlugin.java index 8022129df3699..53dcc916b244f 100644 --- a/server/src/main/java/org/opensearch/plugins/AnalysisPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/AnalysisPlugin.java @@ -72,6 +72,8 @@ * OpenSearch doesn't have any automatic mechanism to share these components between indexes. If any component is heavy enough to warrant * such sharing then it is the Plugin's responsibility to do it in their {@link AnalysisProvider} implementation. We recommend against doing * this unless absolutely necessary because it can be difficult to get the caching right given things like behavior changes across versions. + * + * @opensearch.api */ public interface AnalysisPlugin { /** diff --git a/server/src/main/java/org/opensearch/plugins/CircuitBreakerPlugin.java b/server/src/main/java/org/opensearch/plugins/CircuitBreakerPlugin.java index 01aaddf96a70d..f52aab5b238b3 100644 --- a/server/src/main/java/org/opensearch/plugins/CircuitBreakerPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/CircuitBreakerPlugin.java @@ -39,6 +39,8 @@ /** * An extension point for {@link Plugin} implementations to add custom circuit breakers + * + * @opensearch.api */ public interface CircuitBreakerPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/ClusterPlugin.java b/server/src/main/java/org/opensearch/plugins/ClusterPlugin.java index 54a94d540ce32..b0ed91dd4c468 100644 --- a/server/src/main/java/org/opensearch/plugins/ClusterPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/ClusterPlugin.java @@ -45,6 +45,8 @@ /** * An extension point for {@link Plugin} implementations to customer behavior of cluster management. + * + * @opensearch.api */ public interface ClusterPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/DiscoveryPlugin.java b/server/src/main/java/org/opensearch/plugins/DiscoveryPlugin.java index 764e249474d9b..89433b2a3b67d 100644 --- a/server/src/main/java/org/opensearch/plugins/DiscoveryPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/DiscoveryPlugin.java @@ -57,6 +57,8 @@ * } * } * + * + * @opensearch.api */ public interface DiscoveryPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/EnginePlugin.java b/server/src/main/java/org/opensearch/plugins/EnginePlugin.java index 31844dbdaec2b..92ae2ff9cd661 100644 --- a/server/src/main/java/org/opensearch/plugins/EnginePlugin.java +++ b/server/src/main/java/org/opensearch/plugins/EnginePlugin.java @@ -45,6 +45,8 @@ /** * A plugin that provides alternative engine implementations. + * + * @opensearch.api */ public interface EnginePlugin { diff --git a/server/src/main/java/org/opensearch/plugins/ExtensiblePlugin.java b/server/src/main/java/org/opensearch/plugins/ExtensiblePlugin.java index 55109178cbdff..4dd4010383934 100644 --- a/server/src/main/java/org/opensearch/plugins/ExtensiblePlugin.java +++ b/server/src/main/java/org/opensearch/plugins/ExtensiblePlugin.java @@ -39,6 +39,8 @@ * * This class provides a callback for extensible plugins to be informed of other plugins * which extend them. + * + * @opensearch.api */ public interface ExtensiblePlugin { diff --git a/server/src/main/java/org/opensearch/plugins/IndexStorePlugin.java b/server/src/main/java/org/opensearch/plugins/IndexStorePlugin.java index 0a6e6a9ff3b67..2f549fec54759 100644 --- a/server/src/main/java/org/opensearch/plugins/IndexStorePlugin.java +++ b/server/src/main/java/org/opensearch/plugins/IndexStorePlugin.java @@ -46,6 +46,8 @@ /** * A plugin that provides alternative directory implementations. + * + * @opensearch.api */ public interface IndexStorePlugin { diff --git a/server/src/main/java/org/opensearch/plugins/IngestPlugin.java b/server/src/main/java/org/opensearch/plugins/IngestPlugin.java index d04a3c3add88c..f78170c2ae3af 100644 --- a/server/src/main/java/org/opensearch/plugins/IngestPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/IngestPlugin.java @@ -39,6 +39,8 @@ /** * An extension point for {@link Plugin} implementations to add custom ingest processors + * + * @opensearch.api */ public interface IngestPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/MapperPlugin.java b/server/src/main/java/org/opensearch/plugins/MapperPlugin.java index d31aafb863dc6..ff6daf1b720f6 100644 --- a/server/src/main/java/org/opensearch/plugins/MapperPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/MapperPlugin.java @@ -42,6 +42,8 @@ /** * An extension point for {@link Plugin} implementations to add custom mappers + * + * @opensearch.api */ public interface MapperPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/MetadataUpgrader.java b/server/src/main/java/org/opensearch/plugins/MetadataUpgrader.java index 997fc88e5dbd9..37419b08f4b1e 100644 --- a/server/src/main/java/org/opensearch/plugins/MetadataUpgrader.java +++ b/server/src/main/java/org/opensearch/plugins/MetadataUpgrader.java @@ -42,6 +42,8 @@ /** * Upgrades {@link Metadata} on startup on behalf of installed {@link Plugin}s + * + * @opensearch.api */ public class MetadataUpgrader { public final UnaryOperator> indexTemplateMetadataUpgraders; diff --git a/server/src/main/java/org/opensearch/plugins/NetworkPlugin.java b/server/src/main/java/org/opensearch/plugins/NetworkPlugin.java index b53718fccf42a..c1eb9b579c832 100644 --- a/server/src/main/java/org/opensearch/plugins/NetworkPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/NetworkPlugin.java @@ -52,6 +52,8 @@ /** * Plugin for extending network and transport related classes + * + * @opensearch.api */ public interface NetworkPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/PersistentTaskPlugin.java b/server/src/main/java/org/opensearch/plugins/PersistentTaskPlugin.java index 61cb519f0546d..5eb200f47422d 100644 --- a/server/src/main/java/org/opensearch/plugins/PersistentTaskPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/PersistentTaskPlugin.java @@ -43,6 +43,8 @@ /** * Plugin for registering persistent tasks executors. + * + * @opensearch.api */ public interface PersistentTaskPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/Platforms.java b/server/src/main/java/org/opensearch/plugins/Platforms.java index e9c767ed00880..86a442d593b47 100644 --- a/server/src/main/java/org/opensearch/plugins/Platforms.java +++ b/server/src/main/java/org/opensearch/plugins/Platforms.java @@ -39,6 +39,8 @@ /** * Encapsulates platform-dependent methods for handling native components of plugins. + * + * @opensearch.api */ public class Platforms { diff --git a/server/src/main/java/org/opensearch/plugins/Plugin.java b/server/src/main/java/org/opensearch/plugins/Plugin.java index 9a7dcbd6a78f6..b51de5693dbf4 100644 --- a/server/src/main/java/org/opensearch/plugins/Plugin.java +++ b/server/src/main/java/org/opensearch/plugins/Plugin.java @@ -86,6 +86,8 @@ *
  • {@link SearchPlugin} *
  • {@link ReloadablePlugin} * + * + * @opensearch.api */ public abstract class Plugin implements Closeable { diff --git a/server/src/main/java/org/opensearch/plugins/PluginInfo.java b/server/src/main/java/org/opensearch/plugins/PluginInfo.java index c4867f7a07dc4..bcb8e4d6fc97d 100644 --- a/server/src/main/java/org/opensearch/plugins/PluginInfo.java +++ b/server/src/main/java/org/opensearch/plugins/PluginInfo.java @@ -56,6 +56,8 @@ /** * An in-memory representation of the plugin descriptor. + * + * @opensearch.api */ public class PluginInfo implements Writeable, ToXContentObject { diff --git a/server/src/main/java/org/opensearch/plugins/PluginLoaderIndirection.java b/server/src/main/java/org/opensearch/plugins/PluginLoaderIndirection.java index e62f46038e8ef..199784d1f7630 100644 --- a/server/src/main/java/org/opensearch/plugins/PluginLoaderIndirection.java +++ b/server/src/main/java/org/opensearch/plugins/PluginLoaderIndirection.java @@ -37,6 +37,8 @@ /** * This class exists solely as an intermediate layer to avoid causing PluginsService * to load ExtendedPluginsClassLoader when used in the transport client. + * + * @opensearch.api */ class PluginLoaderIndirection { diff --git a/server/src/main/java/org/opensearch/plugins/PluginSecurity.java b/server/src/main/java/org/opensearch/plugins/PluginSecurity.java index 6665d8088c4ff..e783a53dcb82f 100644 --- a/server/src/main/java/org/opensearch/plugins/PluginSecurity.java +++ b/server/src/main/java/org/opensearch/plugins/PluginSecurity.java @@ -54,6 +54,11 @@ import java.util.Set; import java.util.stream.Collectors; +/** + * Security Policy for Plugins + * + * @opensearch.api + */ class PluginSecurity { /** diff --git a/server/src/main/java/org/opensearch/plugins/ReloadablePlugin.java b/server/src/main/java/org/opensearch/plugins/ReloadablePlugin.java index 6b9194129dd5f..7a0854f2c89b9 100644 --- a/server/src/main/java/org/opensearch/plugins/ReloadablePlugin.java +++ b/server/src/main/java/org/opensearch/plugins/ReloadablePlugin.java @@ -40,6 +40,8 @@ * is reloaded it might rebuild any internal members. Plugins usually implement * this interface in order to reread the values of {@code SecureSetting}s and * then rebuild any dependent internal members. + * + * @opensearch.api */ public interface ReloadablePlugin { /** diff --git a/server/src/main/java/org/opensearch/plugins/RepositoryPlugin.java b/server/src/main/java/org/opensearch/plugins/RepositoryPlugin.java index 2c52961bb5f32..4d0a7b2d0a533 100644 --- a/server/src/main/java/org/opensearch/plugins/RepositoryPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/RepositoryPlugin.java @@ -43,6 +43,8 @@ /** * An extension point for {@link Plugin} implementations to add custom snapshot repositories. + * + * @opensearch.api */ public interface RepositoryPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/ScriptPlugin.java b/server/src/main/java/org/opensearch/plugins/ScriptPlugin.java index 85f75f9940591..7c8d71d21c0fd 100644 --- a/server/src/main/java/org/opensearch/plugins/ScriptPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/ScriptPlugin.java @@ -42,6 +42,8 @@ /** * An additional extension point for {@link Plugin}s that extends OpenSearch's scripting functionality. + * + * @opensearch.api */ public interface ScriptPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/SearchPlugin.java b/server/src/main/java/org/opensearch/plugins/SearchPlugin.java index f650a1ce5512f..a743360e1e90c 100644 --- a/server/src/main/java/org/opensearch/plugins/SearchPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/SearchPlugin.java @@ -87,6 +87,8 @@ /** * Plugin for extending search time behavior. + * + * @opensearch.api */ public interface SearchPlugin { /** diff --git a/server/src/main/java/org/opensearch/plugins/SystemIndexPlugin.java b/server/src/main/java/org/opensearch/plugins/SystemIndexPlugin.java index b7ff72fd231a6..4937a5ed091dc 100644 --- a/server/src/main/java/org/opensearch/plugins/SystemIndexPlugin.java +++ b/server/src/main/java/org/opensearch/plugins/SystemIndexPlugin.java @@ -41,6 +41,8 @@ /** * Plugin for defining system indices. Extends {@link ActionPlugin} because system indices must be accessed via APIs * added by the plugin that owns the system index, rather than standard APIs. + * + * @opensearch.api */ public interface SystemIndexPlugin extends ActionPlugin { diff --git a/server/src/main/java/org/opensearch/plugins/spi/NamedXContentProvider.java b/server/src/main/java/org/opensearch/plugins/spi/NamedXContentProvider.java index ddbf88965f716..0d3c575ce9b9e 100644 --- a/server/src/main/java/org/opensearch/plugins/spi/NamedXContentProvider.java +++ b/server/src/main/java/org/opensearch/plugins/spi/NamedXContentProvider.java @@ -38,6 +38,8 @@ /** * Provides named XContent parsers. + * + * @opensearch.api */ public interface NamedXContentProvider { diff --git a/server/src/main/java/org/opensearch/repositories/FilterRepository.java b/server/src/main/java/org/opensearch/repositories/FilterRepository.java index 09f3b0ae223d5..aaa021a0e8b93 100644 --- a/server/src/main/java/org/opensearch/repositories/FilterRepository.java +++ b/server/src/main/java/org/opensearch/repositories/FilterRepository.java @@ -57,6 +57,11 @@ import java.util.function.Consumer; import java.util.function.Function; +/** + * Repository that is filtered + * + * @opensearch.internal + */ public class FilterRepository implements Repository { private final Repository in; diff --git a/server/src/main/java/org/opensearch/repositories/IndexId.java b/server/src/main/java/org/opensearch/repositories/IndexId.java index 02cf745a455e9..eda98e1af8188 100644 --- a/server/src/main/java/org/opensearch/repositories/IndexId.java +++ b/server/src/main/java/org/opensearch/repositories/IndexId.java @@ -45,6 +45,8 @@ /** * Represents a single snapshotted index in the repository. + * + * @opensearch.internal */ public final class IndexId implements Writeable, ToXContentObject { protected static final String NAME = "name"; diff --git a/server/src/main/java/org/opensearch/repositories/IndexMetaDataGenerations.java b/server/src/main/java/org/opensearch/repositories/IndexMetaDataGenerations.java index 4ea0217c5870f..afabf4ebfdb58 100644 --- a/server/src/main/java/org/opensearch/repositories/IndexMetaDataGenerations.java +++ b/server/src/main/java/org/opensearch/repositories/IndexMetaDataGenerations.java @@ -49,6 +49,8 @@ * {@link org.opensearch.repositories.blobstore.BlobStoreRepository#finalizeSnapshot} the identifier for an instance of * {@link IndexMetadata} should be computed and then used to check if it already exists in the repository via * {@link #getIndexMetaBlobId(String)}. + * + * @opensearch.internal */ public final class IndexMetaDataGenerations { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoriesModule.java b/server/src/main/java/org/opensearch/repositories/RepositoriesModule.java index 228c62c353355..1d38c05c3fbf8 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoriesModule.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoriesModule.java @@ -49,6 +49,8 @@ /** * Sets up classes for Snapshot/Restore. + * + * @opensearch.internal */ public final class RepositoriesModule { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoriesService.java b/server/src/main/java/org/opensearch/repositories/RepositoriesService.java index b521da8453bb2..5b4e30f8495e8 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoriesService.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoriesService.java @@ -79,6 +79,8 @@ /** * Service responsible for maintaining and providing access to snapshot repositories on nodes. + * + * @opensearch.internal */ public class RepositoriesService extends AbstractLifecycleComponent implements ClusterStateApplier { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoriesStatsArchive.java b/server/src/main/java/org/opensearch/repositories/RepositoriesStatsArchive.java index f5c600b5ff444..b8f100706f81e 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoriesStatsArchive.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoriesStatsArchive.java @@ -44,6 +44,11 @@ import java.util.function.LongSupplier; import java.util.stream.Collectors; +/** + * Archive of repository stats + * + * @opensearch.internal + */ public final class RepositoriesStatsArchive { private static final Logger logger = LogManager.getLogger(RepositoriesStatsArchive.class); diff --git a/server/src/main/java/org/opensearch/repositories/Repository.java b/server/src/main/java/org/opensearch/repositories/Repository.java index 18ad02bab48f9..a16e0e8d441bc 100644 --- a/server/src/main/java/org/opensearch/repositories/Repository.java +++ b/server/src/main/java/org/opensearch/repositories/Repository.java @@ -70,6 +70,8 @@ * for each shard
    • *
  • When all shard calls return cluster-manager calls {@link #finalizeSnapshot} with possible list of failures
    • * + * + * @opensearch.internal */ public interface Repository extends LifecycleComponent { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryCleanupResult.java b/server/src/main/java/org/opensearch/repositories/RepositoryCleanupResult.java index 7851274a48fbe..5bed6fb1766b7 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryCleanupResult.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryCleanupResult.java @@ -43,6 +43,11 @@ import java.io.IOException; +/** + * Result of a repository cleanup action + * + * @opensearch.internal + */ public final class RepositoryCleanupResult implements Writeable, ToXContentObject { public static final ObjectParser PARSER = new ObjectParser<>( diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryData.java b/server/src/main/java/org/opensearch/repositories/RepositoryData.java index 7857df512cd75..e8132801e4238 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryData.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryData.java @@ -60,6 +60,8 @@ /** * A class that represents the data in a repository, as captured in the * repository's index blob. + * + * @opensearch.internal */ public final class RepositoryData { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryException.java b/server/src/main/java/org/opensearch/repositories/RepositoryException.java index 8196fa24f2a92..6606bf36a6136 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryException.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryException.java @@ -40,6 +40,8 @@ /** * Generic repository exception + * + * @opensearch.internal */ public class RepositoryException extends OpenSearchException { private final String repository; diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryInfo.java b/server/src/main/java/org/opensearch/repositories/RepositoryInfo.java index 5266cfa28bd0e..e65e328bd8cfd 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryInfo.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryInfo.java @@ -44,6 +44,11 @@ import java.util.Map; import java.util.Objects; +/** + * Information about a repository + * + * @opensearch.internal + */ public final class RepositoryInfo implements Writeable, ToXContentFragment { public final String ephemeralId; public final String name; diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryMissingException.java b/server/src/main/java/org/opensearch/repositories/RepositoryMissingException.java index 5a0b59e50e62f..c84c25127237b 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryMissingException.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryMissingException.java @@ -39,6 +39,8 @@ /** * Repository missing exception + * + * @opensearch.internal */ public class RepositoryMissingException extends RepositoryException { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryOperation.java b/server/src/main/java/org/opensearch/repositories/RepositoryOperation.java index 5e11d3e2f400e..ec8dcd5ca91a3 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryOperation.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryOperation.java @@ -33,6 +33,8 @@ /** * Coordinates of an operation that modifies a repository, assuming that repository at a specific generation. + * + * @opensearch.internal */ public interface RepositoryOperation { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryShardId.java b/server/src/main/java/org/opensearch/repositories/RepositoryShardId.java index cd4e180215db0..1dd4bf438e01e 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryShardId.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryShardId.java @@ -41,6 +41,8 @@ /** * Represents a shard snapshot in a repository. + * + * @opensearch.internal */ public final class RepositoryShardId implements Writeable { diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryStats.java b/server/src/main/java/org/opensearch/repositories/RepositoryStats.java index c832b86eb69a4..006258859822f 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryStats.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryStats.java @@ -42,6 +42,11 @@ import java.util.Map; import java.util.Objects; +/** + * Stats about a repository + * + * @opensearch.internal + */ public class RepositoryStats implements Writeable { public static final RepositoryStats EMPTY_STATS = new RepositoryStats(Collections.emptyMap()); diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryStatsSnapshot.java b/server/src/main/java/org/opensearch/repositories/RepositoryStatsSnapshot.java index c7824e29bc953..e37ec0cba6512 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryStatsSnapshot.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryStatsSnapshot.java @@ -42,6 +42,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Stats snapshot about a repository + * + * @opensearch.internal + */ public final class RepositoryStatsSnapshot implements Writeable, ToXContentObject { public static final long UNKNOWN_CLUSTER_VERSION = -1; private final RepositoryInfo repositoryInfo; diff --git a/server/src/main/java/org/opensearch/repositories/RepositoryVerificationException.java b/server/src/main/java/org/opensearch/repositories/RepositoryVerificationException.java index 949c1b7e25ff9..aaf06f4dbcd7f 100644 --- a/server/src/main/java/org/opensearch/repositories/RepositoryVerificationException.java +++ b/server/src/main/java/org/opensearch/repositories/RepositoryVerificationException.java @@ -39,6 +39,8 @@ /** * Repository verification exception + * + * @opensearch.internal */ public class RepositoryVerificationException extends RepositoryException { diff --git a/server/src/main/java/org/opensearch/repositories/ShardGenerations.java b/server/src/main/java/org/opensearch/repositories/ShardGenerations.java index 28cca3fe26646..5857ec537d1dc 100644 --- a/server/src/main/java/org/opensearch/repositories/ShardGenerations.java +++ b/server/src/main/java/org/opensearch/repositories/ShardGenerations.java @@ -47,6 +47,11 @@ import java.util.regex.Pattern; import java.util.stream.Collectors; +/** + * Generations of shards for snapshots + * + * @opensearch.internal + */ public final class ShardGenerations { public static final ShardGenerations EMPTY = new ShardGenerations(Collections.emptyMap()); diff --git a/server/src/main/java/org/opensearch/repositories/VerificationFailure.java b/server/src/main/java/org/opensearch/repositories/VerificationFailure.java index d285f3418eea5..51f0caed04903 100644 --- a/server/src/main/java/org/opensearch/repositories/VerificationFailure.java +++ b/server/src/main/java/org/opensearch/repositories/VerificationFailure.java @@ -32,6 +32,11 @@ package org.opensearch.repositories; +/** + * Exception thrown when a repository fails verification + * + * @opensearch.internal + */ public class VerificationFailure { private String nodeId; diff --git a/server/src/main/java/org/opensearch/repositories/VerifyNodeRepositoryAction.java b/server/src/main/java/org/opensearch/repositories/VerifyNodeRepositoryAction.java index 70bc4b9590385..6b8c44ed6d54c 100644 --- a/server/src/main/java/org/opensearch/repositories/VerifyNodeRepositoryAction.java +++ b/server/src/main/java/org/opensearch/repositories/VerifyNodeRepositoryAction.java @@ -59,6 +59,11 @@ import java.util.concurrent.CopyOnWriteArrayList; import java.util.concurrent.atomic.AtomicInteger; +/** + * Action to verify a node repository + * + * @opensearch.internal + */ public class VerifyNodeRepositoryAction { private static final Logger logger = LogManager.getLogger(VerifyNodeRepositoryAction.class); diff --git a/server/src/main/java/org/opensearch/repositories/blobstore/BlobStoreRepository.java b/server/src/main/java/org/opensearch/repositories/blobstore/BlobStoreRepository.java index d95612e31ca38..6eaec491c8177 100644 --- a/server/src/main/java/org/opensearch/repositories/blobstore/BlobStoreRepository.java +++ b/server/src/main/java/org/opensearch/repositories/blobstore/BlobStoreRepository.java @@ -166,6 +166,8 @@ *

    * For in depth documentation on how exactly implementations of this class interact with the snapshot functionality please refer to the * documentation of the package {@link org.opensearch.repositories.blobstore}. + * + * @opensearch.internal */ public abstract class BlobStoreRepository extends AbstractLifecycleComponent implements Repository { private static final Logger logger = LogManager.getLogger(BlobStoreRepository.class); diff --git a/server/src/main/java/org/opensearch/repositories/blobstore/ChecksumBlobStoreFormat.java b/server/src/main/java/org/opensearch/repositories/blobstore/ChecksumBlobStoreFormat.java index 467cfecfb9016..cecbedb3d5c22 100644 --- a/server/src/main/java/org/opensearch/repositories/blobstore/ChecksumBlobStoreFormat.java +++ b/server/src/main/java/org/opensearch/repositories/blobstore/ChecksumBlobStoreFormat.java @@ -69,6 +69,8 @@ /** * Snapshot metadata file format used in v2.0 and above + * + * @opensearch.internal */ public final class ChecksumBlobStoreFormat { diff --git a/server/src/main/java/org/opensearch/repositories/blobstore/FileRestoreContext.java b/server/src/main/java/org/opensearch/repositories/blobstore/FileRestoreContext.java index 28c75e51dc407..d6cffcfbb8db8 100644 --- a/server/src/main/java/org/opensearch/repositories/blobstore/FileRestoreContext.java +++ b/server/src/main/java/org/opensearch/repositories/blobstore/FileRestoreContext.java @@ -61,6 +61,8 @@ * restore from some form of a snapshot. It will setup a new store, identify files that need to be copied * for the source, and perform the copies. Implementers must implement the functionality of opening the * underlying file streams for snapshotted lucene file. + * + * @opensearch.internal */ public abstract class FileRestoreContext { diff --git a/server/src/main/java/org/opensearch/repositories/blobstore/MeteredBlobStoreRepository.java b/server/src/main/java/org/opensearch/repositories/blobstore/MeteredBlobStoreRepository.java index a3ebda3982aa9..19452adc9917b 100644 --- a/server/src/main/java/org/opensearch/repositories/blobstore/MeteredBlobStoreRepository.java +++ b/server/src/main/java/org/opensearch/repositories/blobstore/MeteredBlobStoreRepository.java @@ -43,6 +43,11 @@ import java.util.Map; +/** + * A blob store repository that is metered + * + * @opensearch.internal + */ public abstract class MeteredBlobStoreRepository extends BlobStoreRepository { private final RepositoryInfo repositoryInfo; diff --git a/server/src/main/java/org/opensearch/repositories/fs/FsRepository.java b/server/src/main/java/org/opensearch/repositories/fs/FsRepository.java index 51417733ebe61..3b441d32d17fc 100644 --- a/server/src/main/java/org/opensearch/repositories/fs/FsRepository.java +++ b/server/src/main/java/org/opensearch/repositories/fs/FsRepository.java @@ -62,6 +62,8 @@ * Defaults to not chucked. *
    {@code compress}
    If set to true metadata files will be stored compressed. Defaults to false.
    * + * + * @opensearch.internal */ public class FsRepository extends BlobStoreRepository { private static final Logger logger = LogManager.getLogger(FsRepository.class); diff --git a/server/src/main/java/org/opensearch/script/AggregationScript.java b/server/src/main/java/org/opensearch/script/AggregationScript.java index c45541ff93658..84dd308a9088d 100644 --- a/server/src/main/java/org/opensearch/script/AggregationScript.java +++ b/server/src/main/java/org/opensearch/script/AggregationScript.java @@ -46,6 +46,11 @@ import java.util.Map; import java.util.function.Function; +/** + * Scripts for aggregations + * + * @opensearch.internal + */ public abstract class AggregationScript implements ScorerAware { public static final String[] PARAMETERS = {}; diff --git a/server/src/main/java/org/opensearch/script/BucketAggregationScript.java b/server/src/main/java/org/opensearch/script/BucketAggregationScript.java index b87cf85075d9e..ee54e83adcdea 100644 --- a/server/src/main/java/org/opensearch/script/BucketAggregationScript.java +++ b/server/src/main/java/org/opensearch/script/BucketAggregationScript.java @@ -36,6 +36,8 @@ /** * A script used in bucket aggregations that returns a {@code double} value. + * + * @opensearch.internal */ public abstract class BucketAggregationScript { diff --git a/server/src/main/java/org/opensearch/script/BucketAggregationSelectorScript.java b/server/src/main/java/org/opensearch/script/BucketAggregationSelectorScript.java index 45c2df8a8394a..6accb3043b8db 100644 --- a/server/src/main/java/org/opensearch/script/BucketAggregationSelectorScript.java +++ b/server/src/main/java/org/opensearch/script/BucketAggregationSelectorScript.java @@ -36,6 +36,8 @@ /** * A script used in bucket aggregations that returns a {@code boolean} value. + * + * @opensearch.internal */ public abstract class BucketAggregationSelectorScript { diff --git a/server/src/main/java/org/opensearch/script/ClassPermission.java b/server/src/main/java/org/opensearch/script/ClassPermission.java index 0d3166403d5d1..9be8ecbc7c33e 100644 --- a/server/src/main/java/org/opensearch/script/ClassPermission.java +++ b/server/src/main/java/org/opensearch/script/ClassPermission.java @@ -85,6 +85,8 @@ *
  • {@link org.joda.time.ReadableDateTime}
    • *
  • {@link org.joda.time.ReadableInstant}
    • * + * + * @opensearch.internal */ public final class ClassPermission extends BasicPermission { public static final String STANDARD = "<>"; diff --git a/server/src/main/java/org/opensearch/script/DynamicMap.java b/server/src/main/java/org/opensearch/script/DynamicMap.java index 4be4c8575ddae..985d454b0f87c 100644 --- a/server/src/main/java/org/opensearch/script/DynamicMap.java +++ b/server/src/main/java/org/opensearch/script/DynamicMap.java @@ -42,6 +42,8 @@ * functions is provided for the overridden values where the function * is applied to the existing value when one exists for the * corresponding key. + * + * @opensearch.internal */ public final class DynamicMap implements Map { diff --git a/server/src/main/java/org/opensearch/script/ExplainableScoreScript.java b/server/src/main/java/org/opensearch/script/ExplainableScoreScript.java index 6ea3a322449e5..fa6755953c8bd 100644 --- a/server/src/main/java/org/opensearch/script/ExplainableScoreScript.java +++ b/server/src/main/java/org/opensearch/script/ExplainableScoreScript.java @@ -41,6 +41,8 @@ * To be implemented by {@link ScoreScript} which can provided an {@link Explanation} of the score * This is currently not used inside opensearch but it is used, see for example here: * https://github.com/elastic/elasticsearch/issues/8561 + * + * @opensearch.internal */ public interface ExplainableScoreScript { diff --git a/server/src/main/java/org/opensearch/script/FieldScript.java b/server/src/main/java/org/opensearch/script/FieldScript.java index aba3980facc93..40d3e8a70f923 100644 --- a/server/src/main/java/org/opensearch/script/FieldScript.java +++ b/server/src/main/java/org/opensearch/script/FieldScript.java @@ -46,6 +46,8 @@ /** * A script to produce dynamic values for return fields. + * + * @opensearch.internal */ public abstract class FieldScript { diff --git a/server/src/main/java/org/opensearch/script/FilterScript.java b/server/src/main/java/org/opensearch/script/FilterScript.java index ffdf643606cb8..ca3bc79de0929 100644 --- a/server/src/main/java/org/opensearch/script/FilterScript.java +++ b/server/src/main/java/org/opensearch/script/FilterScript.java @@ -42,6 +42,8 @@ /** * A script implementation of a query filter. * See {@link org.opensearch.index.query.ScriptQueryBuilder}. + * + * @opensearch.internal */ public abstract class FilterScript { diff --git a/server/src/main/java/org/opensearch/script/GeneralScriptException.java b/server/src/main/java/org/opensearch/script/GeneralScriptException.java index 86398bff990e7..b52a242b5de92 100644 --- a/server/src/main/java/org/opensearch/script/GeneralScriptException.java +++ b/server/src/main/java/org/opensearch/script/GeneralScriptException.java @@ -47,6 +47,8 @@ * @deprecated Use ScriptException for exceptions from the scripting engine, * otherwise use a more appropriate exception (e.g. if thrown * from various abstractions) + * + * @opensearch.internal */ @Deprecated public class GeneralScriptException extends OpenSearchException implements OpenSearchWrapperException { diff --git a/server/src/main/java/org/opensearch/script/IngestConditionalScript.java b/server/src/main/java/org/opensearch/script/IngestConditionalScript.java index c41fae1f759e8..378ac6e39394f 100644 --- a/server/src/main/java/org/opensearch/script/IngestConditionalScript.java +++ b/server/src/main/java/org/opensearch/script/IngestConditionalScript.java @@ -38,6 +38,8 @@ /** * A script used by {@link org.opensearch.ingest.ConditionalProcessor}. + * + * @opensearch.internal */ public abstract class IngestConditionalScript { diff --git a/server/src/main/java/org/opensearch/script/IngestScript.java b/server/src/main/java/org/opensearch/script/IngestScript.java index 65a7bc1f3e52c..96802df1096e4 100644 --- a/server/src/main/java/org/opensearch/script/IngestScript.java +++ b/server/src/main/java/org/opensearch/script/IngestScript.java @@ -38,6 +38,8 @@ /** * A script used by the Ingest Script Processor. + * + * @opensearch.internal */ public abstract class IngestScript { diff --git a/server/src/main/java/org/opensearch/script/JodaCompatibleZonedDateTime.java b/server/src/main/java/org/opensearch/script/JodaCompatibleZonedDateTime.java index a92d7c4cf45f7..8f48da739359a 100644 --- a/server/src/main/java/org/opensearch/script/JodaCompatibleZonedDateTime.java +++ b/server/src/main/java/org/opensearch/script/JodaCompatibleZonedDateTime.java @@ -69,6 +69,8 @@ /** * A wrapper around ZonedDateTime that exposes joda methods for backcompat. + * + * @opensearch.internal */ public class JodaCompatibleZonedDateTime implements diff --git a/server/src/main/java/org/opensearch/script/NumberSortScript.java b/server/src/main/java/org/opensearch/script/NumberSortScript.java index 4ce1cee6fed17..097e5045aa803 100644 --- a/server/src/main/java/org/opensearch/script/NumberSortScript.java +++ b/server/src/main/java/org/opensearch/script/NumberSortScript.java @@ -36,6 +36,11 @@ import org.apache.lucene.index.LeafReaderContext; import org.opensearch.search.lookup.SearchLookup; +/** + * Script for number sorts + * + * @opensearch.internal + */ public abstract class NumberSortScript extends AbstractSortScript { public static final String[] PARAMETERS = {}; diff --git a/server/src/main/java/org/opensearch/script/ScoreScript.java b/server/src/main/java/org/opensearch/script/ScoreScript.java index 1f690faf2f68b..887032aa97811 100644 --- a/server/src/main/java/org/opensearch/script/ScoreScript.java +++ b/server/src/main/java/org/opensearch/script/ScoreScript.java @@ -50,6 +50,8 @@ /** * A script used for adjusting the score on a per document basis. + * + * @opensearch.internal */ public abstract class ScoreScript { diff --git a/server/src/main/java/org/opensearch/script/ScoreScriptUtils.java b/server/src/main/java/org/opensearch/script/ScoreScriptUtils.java index ed9d4e6c4f8a7..1b1f7d7ba427b 100644 --- a/server/src/main/java/org/opensearch/script/ScoreScriptUtils.java +++ b/server/src/main/java/org/opensearch/script/ScoreScriptUtils.java @@ -48,6 +48,11 @@ import static com.carrotsearch.hppc.BitMixer.mix32; +/** + * Utilities for scoring scripts + * + * @opensearch.internal + */ public final class ScoreScriptUtils { /****** STATIC FUNCTIONS that can be used by users for score calculations **/ diff --git a/server/src/main/java/org/opensearch/script/Script.java b/server/src/main/java/org/opensearch/script/Script.java index 561324e24bd07..a81ffa7b622a5 100644 --- a/server/src/main/java/org/opensearch/script/Script.java +++ b/server/src/main/java/org/opensearch/script/Script.java @@ -95,6 +95,8 @@ * use an empty {@link Map} to specify no params * * + * + * @opensearch.internal */ public final class Script implements ToXContentObject, Writeable { diff --git a/server/src/main/java/org/opensearch/script/ScriptCache.java b/server/src/main/java/org/opensearch/script/ScriptCache.java index 71476ce55d661..1b898b90ba144 100644 --- a/server/src/main/java/org/opensearch/script/ScriptCache.java +++ b/server/src/main/java/org/opensearch/script/ScriptCache.java @@ -50,6 +50,8 @@ /** * Script cache and compilation rate limiter. + * + * @opensearch.internal */ public class ScriptCache { diff --git a/server/src/main/java/org/opensearch/script/ScriptCacheStats.java b/server/src/main/java/org/opensearch/script/ScriptCacheStats.java index 97bf6aa443b0d..cb88759a5cd5d 100644 --- a/server/src/main/java/org/opensearch/script/ScriptCacheStats.java +++ b/server/src/main/java/org/opensearch/script/ScriptCacheStats.java @@ -45,7 +45,14 @@ import java.util.Objects; import java.util.stream.Collectors; -// This class is deprecated in favor of ScriptStats and ScriptContextStats. It is removed in 8. +/** + * Stats for script caching + * + * @opensearch.internal + * + * @deprecated This class is deprecated in favor of ScriptStats and ScriptContextStats. It is removed in OpenSearch 2.0. + */ +@Deprecated public class ScriptCacheStats implements Writeable, ToXContentFragment { private final Map context; private final ScriptStats general; diff --git a/server/src/main/java/org/opensearch/script/ScriptContext.java b/server/src/main/java/org/opensearch/script/ScriptContext.java index 299528494f7dc..27ad1f3ce03c8 100644 --- a/server/src/main/java/org/opensearch/script/ScriptContext.java +++ b/server/src/main/java/org/opensearch/script/ScriptContext.java @@ -69,6 +69,8 @@ * For example, to check if a variable {@code doc} is used, a method {@code boolean needsDoc()} should be added. * If the variable name starts with an underscore, for example, {@code _score}, the needs method would * be {@code boolean needs_score()}. + * + * @opensearch.internal */ public final class ScriptContext { diff --git a/server/src/main/java/org/opensearch/script/ScriptContextInfo.java b/server/src/main/java/org/opensearch/script/ScriptContextInfo.java index 360ef93868722..68297eb12216a 100644 --- a/server/src/main/java/org/opensearch/script/ScriptContextInfo.java +++ b/server/src/main/java/org/opensearch/script/ScriptContextInfo.java @@ -57,6 +57,11 @@ import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg; +/** + * Information about a script context + * + * @opensearch.internal + */ public class ScriptContextInfo implements ToXContentObject, Writeable { public final String name; public final ScriptMethodInfo execute; diff --git a/server/src/main/java/org/opensearch/script/ScriptContextStats.java b/server/src/main/java/org/opensearch/script/ScriptContextStats.java index 345b5193a29d7..ee5c0db3106f6 100644 --- a/server/src/main/java/org/opensearch/script/ScriptContextStats.java +++ b/server/src/main/java/org/opensearch/script/ScriptContextStats.java @@ -41,6 +41,11 @@ import java.io.IOException; import java.util.Objects; +/** + * Stats for a script context + * + * @opensearch.internal + */ public class ScriptContextStats implements Writeable, ToXContentFragment, Comparable { private final String context; private final long compilations; diff --git a/server/src/main/java/org/opensearch/script/ScriptEngine.java b/server/src/main/java/org/opensearch/script/ScriptEngine.java index 35cc0a55237e4..418fbed52da30 100644 --- a/server/src/main/java/org/opensearch/script/ScriptEngine.java +++ b/server/src/main/java/org/opensearch/script/ScriptEngine.java @@ -39,6 +39,8 @@ /** * A script language implementation. + * + * @opensearch.internal */ public interface ScriptEngine extends Closeable { diff --git a/server/src/main/java/org/opensearch/script/ScriptException.java b/server/src/main/java/org/opensearch/script/ScriptException.java index d053d3567610e..8255751189002 100644 --- a/server/src/main/java/org/opensearch/script/ScriptException.java +++ b/server/src/main/java/org/opensearch/script/ScriptException.java @@ -59,6 +59,8 @@ *
  • {@code script}: Identifier for which script failed. *
  • {@code lang}: Scripting engine language, such as "painless" * + * + * @opensearch.internal */ @SuppressWarnings("serial") public class ScriptException extends OpenSearchException { diff --git a/server/src/main/java/org/opensearch/script/ScriptFactory.java b/server/src/main/java/org/opensearch/script/ScriptFactory.java index 6366d5dbc9287..96cba8aa66a2c 100644 --- a/server/src/main/java/org/opensearch/script/ScriptFactory.java +++ b/server/src/main/java/org/opensearch/script/ScriptFactory.java @@ -34,6 +34,8 @@ /** * Contains utility methods for compiled scripts without impacting concrete script signatures + * + * @opensearch.internal */ public interface ScriptFactory { /** Returns {@code true} if the result of the script will be deterministic, {@code false} otherwise. */ diff --git a/server/src/main/java/org/opensearch/script/ScriptLanguagesInfo.java b/server/src/main/java/org/opensearch/script/ScriptLanguagesInfo.java index acc26530211c0..727d6dda85367 100644 --- a/server/src/main/java/org/opensearch/script/ScriptLanguagesInfo.java +++ b/server/src/main/java/org/opensearch/script/ScriptLanguagesInfo.java @@ -90,6 +90,8 @@ * ] * } * + * + * @opensearch.internal */ public class ScriptLanguagesInfo implements ToXContentObject, Writeable { private static final ParseField TYPES_ALLOWED = new ParseField("types_allowed"); diff --git a/server/src/main/java/org/opensearch/script/ScriptMetadata.java b/server/src/main/java/org/opensearch/script/ScriptMetadata.java index 4fde74adbdf41..ed57d978bf2ff 100644 --- a/server/src/main/java/org/opensearch/script/ScriptMetadata.java +++ b/server/src/main/java/org/opensearch/script/ScriptMetadata.java @@ -57,6 +57,8 @@ /** * {@link ScriptMetadata} is used to store user-defined scripts * as part of the {@link ClusterState} using only an id as the key. + * + * @opensearch.internal */ public final class ScriptMetadata implements Metadata.Custom, Writeable, ToXContentFragment { diff --git a/server/src/main/java/org/opensearch/script/ScriptMetrics.java b/server/src/main/java/org/opensearch/script/ScriptMetrics.java index 2a7ccd0a781f0..fd54c757fd017 100644 --- a/server/src/main/java/org/opensearch/script/ScriptMetrics.java +++ b/server/src/main/java/org/opensearch/script/ScriptMetrics.java @@ -34,6 +34,11 @@ import org.opensearch.common.metrics.CounterMetric; +/** + * Metrics for scripts + * + * @opensearch.internal + */ public class ScriptMetrics { final CounterMetric compilationsMetric = new CounterMetric(); final CounterMetric cacheEvictionsMetric = new CounterMetric(); diff --git a/server/src/main/java/org/opensearch/script/ScriptModule.java b/server/src/main/java/org/opensearch/script/ScriptModule.java index 5ccf16bf38457..b5527f6d8d07d 100644 --- a/server/src/main/java/org/opensearch/script/ScriptModule.java +++ b/server/src/main/java/org/opensearch/script/ScriptModule.java @@ -48,6 +48,8 @@ /** * Manages building {@link ScriptService}. + * + * @opensearch.internal */ public class ScriptModule { diff --git a/server/src/main/java/org/opensearch/script/ScriptService.java b/server/src/main/java/org/opensearch/script/ScriptService.java index 7be41dcd242f0..303fc5ccbcf88 100644 --- a/server/src/main/java/org/opensearch/script/ScriptService.java +++ b/server/src/main/java/org/opensearch/script/ScriptService.java @@ -71,6 +71,11 @@ import java.util.function.Function; import java.util.stream.Collectors; +/** + * Service for scripting + * + * @opensearch.internal + */ public class ScriptService implements Closeable, ClusterStateApplier { private static final Logger logger = LogManager.getLogger(ScriptService.class); diff --git a/server/src/main/java/org/opensearch/script/ScriptStats.java b/server/src/main/java/org/opensearch/script/ScriptStats.java index 31ce0683b36d8..34d868f1d6046 100644 --- a/server/src/main/java/org/opensearch/script/ScriptStats.java +++ b/server/src/main/java/org/opensearch/script/ScriptStats.java @@ -46,6 +46,11 @@ import java.util.List; import java.util.Map; +/** + * Stats for scripts + * + * @opensearch.internal + */ public class ScriptStats implements Writeable, ToXContentFragment { private final List contextStats; private final long compilations; diff --git a/server/src/main/java/org/opensearch/script/ScriptType.java b/server/src/main/java/org/opensearch/script/ScriptType.java index 29a6cceef5561..a0428d5c5ae57 100644 --- a/server/src/main/java/org/opensearch/script/ScriptType.java +++ b/server/src/main/java/org/opensearch/script/ScriptType.java @@ -44,6 +44,8 @@ * ScriptType represents the way a script is stored and retrieved from the {@link ScriptService}. * It's also used to by {@link ScriptService} to determine whether or not a {@link Script} is * allowed to be executed based on both default and user-defined settings. + * + * @opensearch.internal */ public enum ScriptType implements Writeable { diff --git a/server/src/main/java/org/opensearch/script/ScriptedMetricAggContexts.java b/server/src/main/java/org/opensearch/script/ScriptedMetricAggContexts.java index 1f187f7f0e8f5..43c6bb0a89890 100644 --- a/server/src/main/java/org/opensearch/script/ScriptedMetricAggContexts.java +++ b/server/src/main/java/org/opensearch/script/ScriptedMetricAggContexts.java @@ -47,6 +47,11 @@ import java.util.Map; import java.util.function.Function; +/** + * Contexts for scripted metric aggregations + * + * @opensearch.internal + */ public class ScriptedMetricAggContexts { public abstract static class InitScript { diff --git a/server/src/main/java/org/opensearch/script/SignificantTermsHeuristicScoreScript.java b/server/src/main/java/org/opensearch/script/SignificantTermsHeuristicScoreScript.java index 8227c673b9d97..9d61407570546 100644 --- a/server/src/main/java/org/opensearch/script/SignificantTermsHeuristicScoreScript.java +++ b/server/src/main/java/org/opensearch/script/SignificantTermsHeuristicScoreScript.java @@ -36,6 +36,8 @@ /** * A script used in significant terms heuristic scoring. + * + * @opensearch.internal */ public abstract class SignificantTermsHeuristicScoreScript { diff --git a/server/src/main/java/org/opensearch/script/SimilarityScript.java b/server/src/main/java/org/opensearch/script/SimilarityScript.java index 1683b8ad43bdf..dbee5af77e309 100644 --- a/server/src/main/java/org/opensearch/script/SimilarityScript.java +++ b/server/src/main/java/org/opensearch/script/SimilarityScript.java @@ -34,7 +34,11 @@ import org.opensearch.index.similarity.ScriptedSimilarity; -/** A script that is used to build {@link ScriptedSimilarity} instances. */ +/** + * A script that is used to build {@link ScriptedSimilarity} instances. + * + * @opensearch.internal + */ public abstract class SimilarityScript { /** Compute the score. diff --git a/server/src/main/java/org/opensearch/script/SimilarityWeightScript.java b/server/src/main/java/org/opensearch/script/SimilarityWeightScript.java index 33f2e76f24f2f..f780f87741680 100644 --- a/server/src/main/java/org/opensearch/script/SimilarityWeightScript.java +++ b/server/src/main/java/org/opensearch/script/SimilarityWeightScript.java @@ -34,7 +34,11 @@ import org.opensearch.index.similarity.ScriptedSimilarity; -/** A script that is used to compute scoring factors that are the same for all documents. */ +/** + * A script that is used to compute scoring factors that are the same for all documents. + * + * @opensearch.internal + */ public abstract class SimilarityWeightScript { /** Compute the weight. diff --git a/server/src/main/java/org/opensearch/script/StoredScriptSource.java b/server/src/main/java/org/opensearch/script/StoredScriptSource.java index a14d1db7259eb..25cff24efb92b 100644 --- a/server/src/main/java/org/opensearch/script/StoredScriptSource.java +++ b/server/src/main/java/org/opensearch/script/StoredScriptSource.java @@ -65,6 +65,8 @@ /** * {@link StoredScriptSource} represents user-defined parameters for a script * saved in the {@link ClusterState}. + * + * @opensearch.internal */ public class StoredScriptSource extends AbstractDiffable implements Writeable, ToXContentObject { diff --git a/server/src/main/java/org/opensearch/script/StringSortScript.java b/server/src/main/java/org/opensearch/script/StringSortScript.java index c518543588b3a..eee60d9dc4ef9 100644 --- a/server/src/main/java/org/opensearch/script/StringSortScript.java +++ b/server/src/main/java/org/opensearch/script/StringSortScript.java @@ -36,6 +36,11 @@ import org.apache.lucene.index.LeafReaderContext; import org.opensearch.search.lookup.SearchLookup; +/** + * Script for sorting strings + * + * @opensearch.internal + */ public abstract class StringSortScript extends AbstractSortScript { public static final String[] PARAMETERS = {}; diff --git a/server/src/main/java/org/opensearch/script/TemplateScript.java b/server/src/main/java/org/opensearch/script/TemplateScript.java index 2e13599af044c..0b03a4fd931c1 100644 --- a/server/src/main/java/org/opensearch/script/TemplateScript.java +++ b/server/src/main/java/org/opensearch/script/TemplateScript.java @@ -36,6 +36,8 @@ /** * A string template rendered as a script. + * + * @opensearch.internal */ public abstract class TemplateScript { diff --git a/server/src/main/java/org/opensearch/script/TermsSetQueryScript.java b/server/src/main/java/org/opensearch/script/TermsSetQueryScript.java index 200779cab2de0..d4a4d1cccbd5b 100644 --- a/server/src/main/java/org/opensearch/script/TermsSetQueryScript.java +++ b/server/src/main/java/org/opensearch/script/TermsSetQueryScript.java @@ -43,6 +43,11 @@ import java.util.Map; import java.util.function.Function; +/** + * Script for terms set query + * + * @opensearch.internal + */ public abstract class TermsSetQueryScript { public static final String[] PARAMETERS = {}; diff --git a/server/src/main/java/org/opensearch/script/UpdateScript.java b/server/src/main/java/org/opensearch/script/UpdateScript.java index aef8049bbeb0b..41f21f337877b 100644 --- a/server/src/main/java/org/opensearch/script/UpdateScript.java +++ b/server/src/main/java/org/opensearch/script/UpdateScript.java @@ -39,6 +39,8 @@ /** * An update script. + * + * @opensearch.internal */ public abstract class UpdateScript { diff --git a/server/src/main/java/org/opensearch/threadpool/AutoQueueAdjustingExecutorBuilder.java b/server/src/main/java/org/opensearch/threadpool/AutoQueueAdjustingExecutorBuilder.java index 2bac5eba9fc28..cd89d6110a072 100644 --- a/server/src/main/java/org/opensearch/threadpool/AutoQueueAdjustingExecutorBuilder.java +++ b/server/src/main/java/org/opensearch/threadpool/AutoQueueAdjustingExecutorBuilder.java @@ -52,6 +52,8 @@ /** * A builder for executors that automatically adjust the queue length as needed, depending on * Little's Law. See https://en.wikipedia.org/wiki/Little's_law for more information. + * + * @opensearch.internal */ public final class AutoQueueAdjustingExecutorBuilder extends ExecutorBuilder { diff --git a/server/src/main/java/org/opensearch/threadpool/CancellableAdapter.java b/server/src/main/java/org/opensearch/threadpool/CancellableAdapter.java index e4133e89485bc..cb37762892599 100644 --- a/server/src/main/java/org/opensearch/threadpool/CancellableAdapter.java +++ b/server/src/main/java/org/opensearch/threadpool/CancellableAdapter.java @@ -36,6 +36,11 @@ import java.util.concurrent.Future; +/** + * A cancellable adapter + * + * @opensearch.internal + */ class CancellableAdapter implements Scheduler.Cancellable { private Future future; diff --git a/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java b/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java index b9f4e31d5766f..5229afb0ec71c 100644 --- a/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java +++ b/server/src/main/java/org/opensearch/threadpool/ExecutorBuilder.java @@ -43,6 +43,8 @@ * Base class for executor builders. * * @param the underlying type of the executor settings + * + * @opensearch.internal */ public abstract class ExecutorBuilder { diff --git a/server/src/main/java/org/opensearch/threadpool/FixedExecutorBuilder.java b/server/src/main/java/org/opensearch/threadpool/FixedExecutorBuilder.java index 7eeea8e1b3f4c..bb21c234e58fe 100644 --- a/server/src/main/java/org/opensearch/threadpool/FixedExecutorBuilder.java +++ b/server/src/main/java/org/opensearch/threadpool/FixedExecutorBuilder.java @@ -47,6 +47,8 @@ /** * A builder for fixed executors. + * + * @opensearch.internal */ public final class FixedExecutorBuilder extends ExecutorBuilder { diff --git a/server/src/main/java/org/opensearch/threadpool/ScalingExecutorBuilder.java b/server/src/main/java/org/opensearch/threadpool/ScalingExecutorBuilder.java index 6a183b01ef1e9..2690a3cc30238 100644 --- a/server/src/main/java/org/opensearch/threadpool/ScalingExecutorBuilder.java +++ b/server/src/main/java/org/opensearch/threadpool/ScalingExecutorBuilder.java @@ -48,6 +48,8 @@ /** * A builder for scaling executors. + * + * @opensearch.internal */ public final class ScalingExecutorBuilder extends ExecutorBuilder { diff --git a/server/src/main/java/org/opensearch/threadpool/ScheduledCancellableAdapter.java b/server/src/main/java/org/opensearch/threadpool/ScheduledCancellableAdapter.java index 31672363d2eaf..7e756e827b69e 100644 --- a/server/src/main/java/org/opensearch/threadpool/ScheduledCancellableAdapter.java +++ b/server/src/main/java/org/opensearch/threadpool/ScheduledCancellableAdapter.java @@ -38,6 +38,11 @@ import java.util.concurrent.ScheduledFuture; import java.util.concurrent.TimeUnit; +/** + * A cancellable adapter that is scheduled + * + * @opensearch.internal + */ class ScheduledCancellableAdapter implements Scheduler.ScheduledCancellable { private final ScheduledFuture scheduledFuture; diff --git a/server/src/main/java/org/opensearch/threadpool/Scheduler.java b/server/src/main/java/org/opensearch/threadpool/Scheduler.java index 3f0dff48fb0f5..7c502216af31b 100644 --- a/server/src/main/java/org/opensearch/threadpool/Scheduler.java +++ b/server/src/main/java/org/opensearch/threadpool/Scheduler.java @@ -53,6 +53,8 @@ /** * Scheduler that allows to schedule one-shot and periodic commands. + * + * @opensearch.internal */ public interface Scheduler { diff --git a/server/src/main/java/org/opensearch/threadpool/ThreadPool.java b/server/src/main/java/org/opensearch/threadpool/ThreadPool.java index c2530ccee5588..a6cb566cba678 100644 --- a/server/src/main/java/org/opensearch/threadpool/ThreadPool.java +++ b/server/src/main/java/org/opensearch/threadpool/ThreadPool.java @@ -72,6 +72,11 @@ import static java.util.Collections.unmodifiableMap; +/** + * The OpenSearch threadpool class + * + * @opensearch.internal + */ public class ThreadPool implements ReportingService, Scheduler { private static final Logger logger = LogManager.getLogger(ThreadPool.class); diff --git a/server/src/main/java/org/opensearch/threadpool/ThreadPoolInfo.java b/server/src/main/java/org/opensearch/threadpool/ThreadPoolInfo.java index 3b34734841c0d..e0414179d4099 100644 --- a/server/src/main/java/org/opensearch/threadpool/ThreadPoolInfo.java +++ b/server/src/main/java/org/opensearch/threadpool/ThreadPoolInfo.java @@ -42,6 +42,11 @@ import java.util.Iterator; import java.util.List; +/** + * Information about a threadpool + * + * @opensearch.internal + */ public class ThreadPoolInfo implements ReportingService.Info, Iterable { private final List infos; diff --git a/server/src/main/java/org/opensearch/threadpool/ThreadPoolStats.java b/server/src/main/java/org/opensearch/threadpool/ThreadPoolStats.java index 92273e15fa280..cf9e85ac30a92 100644 --- a/server/src/main/java/org/opensearch/threadpool/ThreadPoolStats.java +++ b/server/src/main/java/org/opensearch/threadpool/ThreadPoolStats.java @@ -44,6 +44,11 @@ import java.util.Iterator; import java.util.List; +/** + * Stats for a threadpool + * + * @opensearch.internal + */ public class ThreadPoolStats implements Writeable, ToXContentFragment, Iterable { public static class Stats implements Writeable, ToXContentFragment, Comparable { diff --git a/server/src/main/java/org/opensearch/usage/UsageService.java b/server/src/main/java/org/opensearch/usage/UsageService.java index 6f8f0076d50f8..14e25b591bda0 100644 --- a/server/src/main/java/org/opensearch/usage/UsageService.java +++ b/server/src/main/java/org/opensearch/usage/UsageService.java @@ -61,6 +61,8 @@ /** * A service to monitor usage of OpenSearch features. + * + * @opensearch.internal */ public class UsageService { diff --git a/server/src/main/java/org/opensearch/watcher/AbstractResourceWatcher.java b/server/src/main/java/org/opensearch/watcher/AbstractResourceWatcher.java index 9f33bb2d4f868..dc0976b123327 100644 --- a/server/src/main/java/org/opensearch/watcher/AbstractResourceWatcher.java +++ b/server/src/main/java/org/opensearch/watcher/AbstractResourceWatcher.java @@ -38,6 +38,8 @@ /** * Abstract resource watcher framework, which handles adding and removing listeners * and calling resource observer. + * + * @opensearch.internal */ public abstract class AbstractResourceWatcher implements ResourceWatcher { private final List listeners = new CopyOnWriteArrayList<>(); diff --git a/server/src/main/java/org/opensearch/watcher/FileChangesListener.java b/server/src/main/java/org/opensearch/watcher/FileChangesListener.java index a9843ad6ed879..7c6132946bbcb 100644 --- a/server/src/main/java/org/opensearch/watcher/FileChangesListener.java +++ b/server/src/main/java/org/opensearch/watcher/FileChangesListener.java @@ -35,6 +35,8 @@ /** * Callback interface that file changes File Watcher is using to notify listeners about changes. + * + * @opensearch.internal */ public interface FileChangesListener { /** diff --git a/server/src/main/java/org/opensearch/watcher/FileWatcher.java b/server/src/main/java/org/opensearch/watcher/FileWatcher.java index ec9fe0c1a1615..9eef64a3cb2db 100644 --- a/server/src/main/java/org/opensearch/watcher/FileWatcher.java +++ b/server/src/main/java/org/opensearch/watcher/FileWatcher.java @@ -46,6 +46,8 @@ * File resources watcher * * The file watcher checks directory and all its subdirectories for file changes and notifies its listeners accordingly + * + * @opensearch.internal */ public class FileWatcher extends AbstractResourceWatcher { diff --git a/server/src/main/java/org/opensearch/watcher/ResourceWatcher.java b/server/src/main/java/org/opensearch/watcher/ResourceWatcher.java index 43bcf601c997f..0c656c52388df 100644 --- a/server/src/main/java/org/opensearch/watcher/ResourceWatcher.java +++ b/server/src/main/java/org/opensearch/watcher/ResourceWatcher.java @@ -38,6 +38,8 @@ *

    * Different resource watchers can be registered with {@link ResourceWatcherService} to be called * periodically in order to check for changes in different external resources. + * + * @opensearch.internal */ public interface ResourceWatcher { /** diff --git a/server/src/main/java/org/opensearch/watcher/ResourceWatcherService.java b/server/src/main/java/org/opensearch/watcher/ResourceWatcherService.java index 9422ef7aa60ae..b8c819e187efd 100644 --- a/server/src/main/java/org/opensearch/watcher/ResourceWatcherService.java +++ b/server/src/main/java/org/opensearch/watcher/ResourceWatcherService.java @@ -53,6 +53,8 @@ * method. This service will call {@link org.opensearch.watcher.ResourceWatcher#checkAndNotify()} method of all * registered watcher periodically. The frequency of checks can be specified using {@code resource.reload.interval} setting, which * defaults to {@code 60s}. The service can be disabled by setting {@code resource.reload.enabled} setting to {@code false}. + * + * @opensearch.internal */ public class ResourceWatcherService implements Closeable { private static final Logger logger = LogManager.getLogger(ResourceWatcherService.class); diff --git a/server/src/main/java/org/opensearch/watcher/WatcherHandle.java b/server/src/main/java/org/opensearch/watcher/WatcherHandle.java index b6aa1df39e4eb..6890364cd0cd6 100644 --- a/server/src/main/java/org/opensearch/watcher/WatcherHandle.java +++ b/server/src/main/java/org/opensearch/watcher/WatcherHandle.java @@ -32,6 +32,11 @@ package org.opensearch.watcher; +/** + * Handle to a watcher + * + * @opensearch.internal + */ public class WatcherHandle { private final ResourceWatcherService.ResourceMonitor monitor;