[Javadocs] add to o.o.action.admin (opensearch-project#3155)

Adds javadocs to classes in package o.o.action.admin.

Signed-off-by: Nicholas Walter Knize <[email protected]>

gradle/missing-javadoc.gradle

@@ -180,7 +180,7 @@ configure(project(":server")) {
   project.tasks.withType(MissingJavadocTask) {
     isExcluded = true
     // TODO: reenable after fixing missing javadocs
-    // javadocMissingLevel = "class"
+    javadocMissingLevel = "class"
   }
 }
 

server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainAction.java

@@ -36,6 +36,8 @@
 
 /**
  * ActionType for explaining shard allocation for a shard in the cluster
+ *
+ * @opensearch.internal
  */
 public class ClusterAllocationExplainAction extends ActionType<ClusterAllocationExplainResponse> {
 

server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainRequest.java

@@ -47,6 +47,8 @@
 
 /**
  * A request to explain the allocation of a shard in the cluster
+ *
+ * @opensearch.internal
  */
 public class ClusterAllocationExplainRequest extends MasterNodeRequest<ClusterAllocationExplainRequest> {
 

server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainRequestBuilder.java

@@ -37,6 +37,8 @@
 
 /**
  * Builder for requests to explain the allocation of a shard in the cluster
+ *
+ * @opensearch.internal
  */
 public class ClusterAllocationExplainRequestBuilder extends MasterNodeOperationRequestBuilder<
     ClusterAllocationExplainRequest,

server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplainResponse.java

@@ -40,6 +40,8 @@
 
 /**
  * Explanation response for a shard in the cluster
+ *
+ * @opensearch.internal
  */
 public class ClusterAllocationExplainResponse extends ActionResponse {
 

server/src/main/java/org/opensearch/action/admin/cluster/allocation/ClusterAllocationExplanation.java

@@ -57,6 +57,8 @@
  * A {@code ClusterAllocationExplanation} is an explanation of why a shard is unassigned,
  * or if it is not unassigned, then which nodes it could possibly be relocated to.
  * It is an immutable class.
+ *
+ * @opensearch.internal
  */
 public final class ClusterAllocationExplanation implements ToXContentObject, Writeable {
 

server/src/main/java/org/opensearch/action/admin/cluster/allocation/TransportClusterAllocationExplainAction.java

@@ -65,6 +65,8 @@
 /**
  * The {@code TransportClusterAllocationExplainAction} is responsible for actually executing the explanation of a shard's allocation on the
  * cluster-manager node in the cluster.
+ *
+ * @opensearch.internal
  */
 public class TransportClusterAllocationExplainAction extends TransportMasterNodeAction<
     ClusterAllocationExplainRequest,

server/src/main/java/org/opensearch/action/admin/cluster/configuration/AddVotingConfigExclusionsAction.java

@@ -33,7 +33,12 @@
 
 import org.opensearch.action.ActionType;
 
-public class AddVotingConfigExclusionsAction extends ActionType<AddVotingConfigExclusionsResponse> {
+/**
+ * Transport endpoint for adding exclusions to voting config
+ *
+ * @opensearch.internal
+ */
+public final class AddVotingConfigExclusionsAction extends ActionType<AddVotingConfigExclusionsResponse> {
     public static final AddVotingConfigExclusionsAction INSTANCE = new AddVotingConfigExclusionsAction();
     public static final String NAME = "cluster:admin/voting_config/add_exclusions";
 

server/src/main/java/org/opensearch/action/admin/cluster/configuration/AddVotingConfigExclusionsRequest.java

@@ -56,6 +56,8 @@
 /**
  * A request to add voting config exclusions for certain cluster-manager-eligible nodes, and wait for these nodes to be removed from the voting
  * configuration.
+ *
+ * @opensearch.internal
  */
 public class AddVotingConfigExclusionsRequest extends MasterNodeRequest<AddVotingConfigExclusionsRequest> {
     public static final String DEPRECATION_MESSAGE = "nodeDescription is deprecated and will be removed, use nodeIds or nodeNames instead";

server/src/main/java/org/opensearch/action/admin/cluster/configuration/AddVotingConfigExclusionsResponse.java

@@ -42,6 +42,8 @@
 /**
  * A response to {@link AddVotingConfigExclusionsRequest} indicating that voting config exclusions have been added for the requested nodes
  * and these nodes have been removed from the voting configuration.
+ *
+ * @opensearch.internal
  */
 public class AddVotingConfigExclusionsResponse extends ActionResponse implements ToXContentObject {
 

server/src/main/java/org/opensearch/action/admin/cluster/configuration/ClearVotingConfigExclusionsAction.java

@@ -33,6 +33,11 @@
 
 import org.opensearch.action.ActionType;
 
+/**
+ * Transport endpoint for clearing exclusions to voting config
+ *
+ * @opensearch.internal
+ */
 public class ClearVotingConfigExclusionsAction extends ActionType<ClearVotingConfigExclusionsResponse> {
     public static final ClearVotingConfigExclusionsAction INSTANCE = new ClearVotingConfigExclusionsAction();
     public static final String NAME = "cluster:admin/voting_config/clear_exclusions";

server/src/main/java/org/opensearch/action/admin/cluster/configuration/ClearVotingConfigExclusionsRequest.java

@@ -42,6 +42,8 @@
 /**
  * A request to clear the voting config exclusions from the cluster state, optionally waiting for these nodes to be removed from the
  * cluster first.
+ *
+ * @opensearch.internal
  */
 public class ClearVotingConfigExclusionsRequest extends MasterNodeRequest<ClearVotingConfigExclusionsRequest> {
     private boolean waitForRemoval = true;

server/src/main/java/org/opensearch/action/admin/cluster/configuration/ClearVotingConfigExclusionsResponse.java

@@ -42,6 +42,8 @@
 /**
  * A response to {@link ClearVotingConfigExclusionsRequest} indicating that voting config exclusions have been cleared from the
  * cluster state.
+ *
+ * @opensearch.internal
  */
 public class ClearVotingConfigExclusionsResponse extends ActionResponse implements ToXContentObject {
     public ClearVotingConfigExclusionsResponse() {}

server/src/main/java/org/opensearch/action/admin/cluster/configuration/TransportAddVotingConfigExclusionsAction.java

@@ -66,6 +66,11 @@
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
+/**
+ * Transport endpoint action for adding exclusions to voting config
+ *
+ * @opensearch.internal
+ */
 public class TransportAddVotingConfigExclusionsAction extends TransportMasterNodeAction<
     AddVotingConfigExclusionsRequest,
     AddVotingConfigExclusionsResponse> {

server/src/main/java/org/opensearch/action/admin/cluster/configuration/TransportClearVotingConfigExclusionsAction.java

@@ -60,6 +60,11 @@
 import java.io.IOException;
 import java.util.function.Predicate;
 
+/**
+ * Transport endpoint action for clearing exclusions to voting config
+ *
+ * @opensearch.internal
+ */
 public class TransportClearVotingConfigExclusionsAction extends TransportMasterNodeAction<
     ClearVotingConfigExclusionsRequest,
     ClearVotingConfigExclusionsResponse> {

server/src/main/java/org/opensearch/action/admin/cluster/health/ClusterHealthAction.java

@@ -34,6 +34,11 @@
 
 import org.opensearch.action.ActionType;
 
+/**
+ * Transport endpoint action for obtaining cluster health
+ *
+ * @opensearch.internal
+ */
 public class ClusterHealthAction extends ActionType<ClusterHealthResponse> {
 
     public static final ClusterHealthAction INSTANCE = new ClusterHealthAction();

server/src/main/java/org/opensearch/action/admin/cluster/health/ClusterHealthRequest.java

@@ -48,6 +48,11 @@
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
+/**
+ * Transport request for requesting cluster health
+ *
+ * @opensearch.internal
+ */
 public class ClusterHealthRequest extends MasterNodeReadRequest<ClusterHealthRequest> implements IndicesRequest.Replaceable {
 
     private String[] indices;

server/src/main/java/org/opensearch/action/admin/cluster/health/ClusterHealthRequestBuilder.java

@@ -40,6 +40,11 @@
 import org.opensearch.common.Priority;
 import org.opensearch.common.unit.TimeValue;
 
+/**
+ * Builder for requesting cluster health
+ *
+ * @opensearch.internal
+ */
 public class ClusterHealthRequestBuilder extends MasterNodeReadOperationRequestBuilder<
     ClusterHealthRequest,
     ClusterHealthResponse,

server/src/main/java/org/opensearch/action/admin/cluster/health/ClusterHealthResponse.java

@@ -60,6 +60,11 @@
 import static org.opensearch.common.xcontent.ConstructingObjectParser.constructorArg;
 import static org.opensearch.common.xcontent.ConstructingObjectParser.optionalConstructorArg;
 
+/**
+ * Transport response for Cluster Health
+ *
+ * @opensearch.internal
+ */
 public class ClusterHealthResponse extends ActionResponse implements StatusToXContentObject {
     private static final String CLUSTER_NAME = "cluster_name";
     private static final String STATUS = "status";

server/src/main/java/org/opensearch/action/admin/cluster/health/TransportClusterHealthAction.java

@@ -67,6 +67,11 @@
 import java.util.function.Consumer;
 import java.util.function.Predicate;
 
+/**
+ * Transport action for obtaining Cluster Health
+ *
+ * @opensearch.internal
+ */
 public class TransportClusterHealthAction extends TransportMasterNodeReadAction<ClusterHealthRequest, ClusterHealthResponse> {
 
     private static final Logger logger = LogManager.getLogger(TransportClusterHealthAction.class);

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/NodeHotThreads.java

@@ -39,6 +39,11 @@
 
 import java.io.IOException;
 
+/**
+ * Transport for OpenSearch Hot Threads
+ *
+ * @opensearch.internal
+ */
 public class NodeHotThreads extends BaseNodeResponse {
 
     private String hotThreads;

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/NodesHotThreadsAction.java

@@ -34,6 +34,11 @@
 
 import org.opensearch.action.ActionType;
 
+/**
+ * Transport action for requesting OpenSearch Hot Threads
+ *
+ * @opensearch.internal
+ */
 public class NodesHotThreadsAction extends ActionType<NodesHotThreadsResponse> {
 
     public static final NodesHotThreadsAction INSTANCE = new NodesHotThreadsAction();

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/NodesHotThreadsRequest.java

@@ -40,6 +40,11 @@
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;
 
+/**
+ * Transport request for OpenSearch Hot Threads
+ *
+ * @opensearch.internal
+ */
 public class NodesHotThreadsRequest extends BaseNodesRequest<NodesHotThreadsRequest> {
 
     int threads = 3;

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/NodesHotThreadsRequestBuilder.java

@@ -36,6 +36,11 @@
 import org.opensearch.client.OpenSearchClient;
 import org.opensearch.common.unit.TimeValue;
 
+/**
+ * Builder class for requesting OpenSearch Hot Threads
+ *
+ * @opensearch.internal
+ */
 public class NodesHotThreadsRequestBuilder extends NodesOperationRequestBuilder<
     NodesHotThreadsRequest,
     NodesHotThreadsResponse,

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/NodesHotThreadsResponse.java

@@ -41,6 +41,11 @@
 import java.io.IOException;
 import java.util.List;
 
+/**
+ * Transport response for OpenSearch Hot Threads
+ *
+ * @opensearch.internal
+ */
 public class NodesHotThreadsResponse extends BaseNodesResponse<NodeHotThreads> {
 
     public NodesHotThreadsResponse(StreamInput in) throws IOException {

server/src/main/java/org/opensearch/action/admin/cluster/node/hotthreads/TransportNodesHotThreadsAction.java

@@ -48,6 +48,11 @@
 import java.io.IOException;
 import java.util.List;
 
+/**
+ * Transport action for OpenSearch Hot Threads
+ *
+ * @opensearch.internal
+ */
 public class TransportNodesHotThreadsAction extends TransportNodesAction<
     NodesHotThreadsRequest,
     NodesHotThreadsResponse,

server/src/main/java/org/opensearch/action/admin/cluster/node/info/NodeInfo.java

@@ -58,6 +58,8 @@
 
 /**
  * Node information (static, does not change over time).
+ *
+ * @opensearch.internal
  */
 public class NodeInfo extends BaseNodeResponse {
 

server/src/main/java/org/opensearch/action/admin/cluster/node/info/NodesInfoAction.java

@@ -34,6 +34,11 @@
 
 import org.opensearch.action.ActionType;
 
+/**
+ * Transport action for OpenSearch Node Information
+ *
+ * @opensearch.internal
+ */
 public class NodesInfoAction extends ActionType<NodesInfoResponse> {
 
     public static final NodesInfoAction INSTANCE = new NodesInfoAction();

server/src/main/java/org/opensearch/action/admin/cluster/node/info/NodesInfoRequest.java

@@ -47,6 +47,8 @@
 
 /**
  * A request to get node (cluster) level information.
+ *
+ * @opensearch.internal
  */
 public class NodesInfoRequest extends BaseNodesRequest<NodesInfoRequest> {
 

server/src/main/java/org/opensearch/action/admin/cluster/node/info/NodesInfoRequestBuilder.java

@@ -35,6 +35,11 @@
 import org.opensearch.action.support.nodes.NodesOperationRequestBuilder;
 import org.opensearch.client.OpenSearchClient;
 
+/**
+ * Transport action for OpenSearch Node Information
+ *
+ * @opensearch.internal
+ */
 public class NodesInfoRequestBuilder extends NodesOperationRequestBuilder<NodesInfoRequest, NodesInfoResponse, NodesInfoRequestBuilder> {
 
     public NodesInfoRequestBuilder(OpenSearchClient client, NodesInfoAction action) {

server/src/main/java/org/opensearch/action/admin/cluster/node/info/NodesInfoResponse.java

@@ -56,6 +56,11 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Transport response for OpenSearch Node Information
+ *
+ * @opensearch.internal
+ */
 public class NodesInfoResponse extends BaseNodesResponse<NodeInfo> implements ToXContentFragment {
 
     public NodesInfoResponse(StreamInput in) throws IOException {

server/src/main/java/org/opensearch/action/admin/cluster/node/info/PluginsAndModules.java

@@ -46,6 +46,8 @@
 
 /**
  * Information about plugins and modules
+ *
+ * @opensearch.internal
  */
 public class PluginsAndModules implements ReportingService.Info {
     private final List<PluginInfo> plugins;

server/src/main/java/org/opensearch/action/admin/cluster/node/info/TransportNodesInfoAction.java

@@ -48,6 +48,11 @@
 import java.util.List;
 import java.util.Set;
 
+/**
+ * Transport action for OpenSearch Node Information
+ *
+ * @opensearch.internal
+ */
 public class TransportNodesInfoAction extends TransportNodesAction<
     NodesInfoRequest,
     NodesInfoResponse,

server/src/main/java/org/opensearch/action/admin/cluster/node/liveness/LivenessRequest.java

@@ -40,6 +40,8 @@
 /**
  * Transport level private response for the transport handler registered under
  * {@value TransportLivenessAction#NAME}
+ *
+ * @opensearch.internal
  */
 public final class LivenessRequest extends ActionRequest {
     public LivenessRequest() {}

server/src/main/java/org/opensearch/action/admin/cluster/node/liveness/LivenessResponse.java

@@ -43,6 +43,8 @@
 /**
  * Transport level private response for the transport handler registered under
  * {@value TransportLivenessAction#NAME}
+ *
+ * @opensearch.internal
  */
 public final class LivenessResponse extends ActionResponse {
 

server/src/main/java/org/opensearch/action/admin/cluster/node/liveness/TransportLivenessAction.java

@@ -40,6 +40,11 @@
 import org.opensearch.transport.TransportRequestHandler;
 import org.opensearch.transport.TransportService;
 
+/**
+ * Transport action for OpenSearch Node Liveness
+ *
+ * @opensearch.internal
+ */
 public final class TransportLivenessAction implements TransportRequestHandler<LivenessRequest> {
 
     private final ClusterService clusterService;

server/src/main/java/org/opensearch/action/admin/cluster/node/reload/NodesReloadSecureSettingsAction.java

@@ -34,6 +34,11 @@
 
 import org.opensearch.action.ActionType;
 
+/**
+ * Transport action for reloading OpenSearch Secure Settings
+ *
+ * @opensearch.internal
+ */
 public class NodesReloadSecureSettingsAction extends ActionType<NodesReloadSecureSettingsResponse> {
 
     public static final NodesReloadSecureSettingsAction INSTANCE = new NodesReloadSecureSettingsAction();