[Javadocs] add to o.o.action, index, and transport (#3277) (#3281)

Adds javadocs to internal classes in org.opensearch.action, index, and transport
packages.

Signed-off-by: Nicholas Walter Knize <[email protected]>
(cherry picked from commit b78176a)

Co-authored-by: Nick Knize <[email protected]>

server/src/main/java/org/opensearch/action/DocWriteResponse.java

@@ -391,6 +391,8 @@ protected static void parseInnerToXContent(XContentParser parser, Builder contex
      * Base class of all {@link DocWriteResponse} builders. These {@link DocWriteResponse.Builder} are used during
      * xcontent parsing to temporarily store the parsed values, then the {@link Builder#build()} method is called to
      * instantiate the appropriate {@link DocWriteResponse} with the parsed values.
+     *
+     * @opensearch.internal
      */
     public abstract static class Builder {
 

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

@@ -107,6 +107,11 @@ protected NodeHotThreads nodeOperation(NodeRequest request) {
         }
     }
 
+    /**
+     * Inner node request
+     *
+     * @opensearch.internal
+     */
     public static class NodeRequest extends BaseNodeRequest {
 
         NodesHotThreadsRequest request;

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

@@ -116,6 +116,11 @@ protected NodeInfo nodeOperation(NodeInfoRequest nodeRequest) {
         );
     }
 
+    /**
+     * Inner Node Info Request
+     *
+     * @opensearch.internal
+     */
     public static class NodeInfoRequest extends BaseNodeRequest {
 
         NodesInfoRequest request;

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

@@ -103,6 +103,11 @@ public String toString() {
         }
     }
 
+    /**
+     * Inner Node Response
+     *
+     * @opensearch.internal
+     */
     public static class NodeResponse extends BaseNodeResponse {
 
         private Exception reloadException = null;

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

@@ -178,6 +178,11 @@ protected NodesReloadSecureSettingsResponse.NodeResponse nodeOperation(NodeReque
         }
     }
 
+    /**
+     * Inner Node Request
+     *
+     * @opensearch.internal
+     */
     public static class NodeRequest extends BaseNodeRequest {
 
         NodesReloadSecureSettingsRequest request;

server/src/main/java/org/opensearch/action/admin/cluster/node/stats/TransportNodesStatsAction.java

@@ -117,6 +117,11 @@ protected NodeStats nodeOperation(NodeStatsRequest nodeStatsRequest) {
         );
     }
 
+    /**
+     * Inner Node Stats Request
+     *
+     * @opensearch.internal
+     */
     public static class NodeStatsRequest extends BaseNodeRequest {
 
         NodesStatsRequest request;

server/src/main/java/org/opensearch/action/admin/cluster/node/tasks/list/TaskGroup.java

@@ -60,6 +60,11 @@ public static Builder builder(TaskInfo taskInfo) {
         return new Builder(taskInfo);
     }
 
+    /**
+     * Builder for the Task Group
+     *
+     * @opensearch.internal
+     */
     public static class Builder {
         private TaskInfo taskInfo;
         private List<Builder> childTasks;

server/src/main/java/org/opensearch/action/admin/cluster/node/usage/TransportNodesUsageAction.java

@@ -107,6 +107,11 @@ protected NodeUsage nodeOperation(NodeUsageRequest nodeUsageRequest) {
         return new NodeUsage(clusterService.localNode(), System.currentTimeMillis(), sinceTime, restUsage, aggsUsage);
     }
 
+    /**
+     * Inner Node Usage Request
+     *
+     * @opensearch.internal
+     */
     public static class NodeUsageRequest extends BaseNodeRequest {
 
         NodesUsageRequest request;

server/src/main/java/org/opensearch/action/admin/cluster/repositories/verify/VerifyRepositoryResponse.java

@@ -58,6 +58,11 @@ public class VerifyRepositoryResponse extends ActionResponse implements ToXConte
     static final String NODES = "nodes";
     static final String NAME = "name";
 
+    /**
+     * Inner Node View
+     *
+     * @opensearch.internal
+     */
     public static class NodeView implements Writeable, ToXContentObject {
         private static final ObjectParser.NamedObjectParser<NodeView, Void> PARSER;
         static {

server/src/main/java/org/opensearch/action/admin/cluster/reroute/TransportClusterRerouteAction.java

@@ -209,6 +209,11 @@ private void submitStateUpdate(final ClusterRerouteRequest request, final Action
         );
     }
 
+    /**
+     * Inner Reroute Response Acknowledged the Cluster State Update
+     *
+     * @opensearch.internal
+     */
     static class ClusterRerouteResponseAckedClusterStateUpdateTask extends AckedClusterStateUpdateTask<ClusterRerouteResponse> {
 
         private final ClusterRerouteRequest request;

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/status/SnapshotIndexShardStatus.java

@@ -161,6 +161,11 @@ public void writeTo(StreamOutput out) throws IOException {
         out.writeOptionalString(failure);
     }
 
+    /**
+     * Inner Fields used for creating XContent and parsing
+     *
+     * @opensearch.internal
+     */
     static final class Fields {
         static final String STAGE = "stage";
         static final String REASON = "reason";

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/status/SnapshotIndexStatus.java

@@ -122,6 +122,11 @@ public Iterator<SnapshotIndexShardStatus> iterator() {
         return indexShards.values().iterator();
     }
 
+    /**
+     * Inner Fields used for creating XContent and parsing
+     *
+     * @opensearch.internal
+     */
     static final class Fields {
         static final String SHARDS = "shards";
     }

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/status/SnapshotShardsStats.java

@@ -139,6 +139,11 @@ public int getTotalShards() {
         return totalShards;
     }
 
+    /**
+     * Inner Fields used for creating XContent and parsing
+     *
+     * @opensearch.internal
+     */
     static final class Fields {
         static final String SHARDS_STATS = "shards_stats";
         static final String INITIALIZING = "initializing";

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/status/SnapshotStats.java

@@ -165,6 +165,11 @@ public void writeTo(StreamOutput out) throws IOException {
         out.writeVLong(totalSize);
     }
 
+    /**
+     * Inner Fields used for creating XContent and parsing
+     *
+     * @opensearch.internal
+     */
     static final class Fields {
         static final String STATS = "stats";
 

server/src/main/java/org/opensearch/action/admin/cluster/snapshots/status/TransportNodesSnapshotsStatus.java

@@ -143,6 +143,11 @@ protected NodeSnapshotStatus nodeOperation(NodeRequest request) {
         }
     }
 
+    /**
+     * Inner Request
+     *
+     * @opensearch.internal
+     */
     public static class Request extends BaseNodesRequest<Request> {
 
         private Snapshot[] snapshots;
@@ -169,6 +174,11 @@ public void writeTo(StreamOutput out) throws IOException {
         }
     }
 
+    /**
+     * Inner Node Snapshot Status
+     *
+     * @opensearch.internal
+     */
     public static class NodesSnapshotStatus extends BaseNodesResponse<NodeSnapshotStatus> {
 
         public NodesSnapshotStatus(StreamInput in) throws IOException {
@@ -190,6 +200,11 @@ protected void writeNodesTo(StreamOutput out, List<NodeSnapshotStatus> nodes) th
         }
     }
 
+    /**
+     * Inner Node Request
+     *
+     * @opensearch.internal
+     */
     public static class NodeRequest extends BaseNodeRequest {
 
         private final List<Snapshot> snapshots;
@@ -210,6 +225,11 @@ public void writeTo(StreamOutput out) throws IOException {
         }
     }
 
+    /**
+     * Inner Node Shapshot Status
+     *
+     * @opensearch.internal
+     */
     public static class NodeSnapshotStatus extends BaseNodeResponse {
 
         private final Map<Snapshot, Map<ShardId, SnapshotIndexShardStatus>> status;

server/src/main/java/org/opensearch/action/admin/cluster/stats/ClusterStatsIndices.java

@@ -144,6 +144,11 @@ public AnalysisStats getAnalysis() {
         return analysis;
     }
 
+    /**
+     * Inner Fields used for creating XContent and parsing
+     *
+     * @opensearch.internal
+     */
     static final class Fields {
         static final String COUNT = "count";
     }
@@ -167,6 +172,11 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         return builder;
     }
 
+    /**
+     * Inner Shard Stats
+     *
+     * @opensearch.internal
+     */
     public static class ShardStats implements ToXContentFragment {
 
         int indices;
@@ -311,6 +321,11 @@ public void addIndexShardCount(ShardStats indexShardCount) {
             }
         }
 
+        /**
+         * Inner Fields used for creating XContent and parsing
+         *
+         * @opensearch.internal
+         */
         static final class Fields {
             static final String SHARDS = "shards";
             static final String TOTAL = "total";