addressing PR comments

Signed-off-by: Himshikha Gupta <himshikh@amazon.com>
opensearch-project · Jun 4, 2024 · 8ecf865 · 8ecf865
1 parent b3c18d8
commit 8ecf865
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/server/src/main/java/org/opensearch/gateway/remote/ClusterMetadataManifest.java b/server/src/main/java/org/opensearch/gateway/remote/ClusterMetadataManifest.java
@@ -41,7 +41,7 @@ public class ClusterMetadataManifest implements Writeable, ToXContentFragment {
     public static final int CODEC_V0 = 0; // Older codec version, where we haven't introduced codec versions for manifest.
     public static final int CODEC_V1 = 1; // In Codec V1 we have introduced global-metadata and codec version in Manifest file.
     public static final int CODEC_V2 = 2; // In Codec V2, there are seperate metadata files rather than a single global metadata file.
-    public static final int CODEC_V3 = 3; // In Codec V2 we introduce index routing-metadata in manifest file.
+    public static final int CODEC_V3 = 3; // In Codec V3, we introduce index routing-metadata in manifest file.
 
     private static final ParseField CLUSTER_TERM_FIELD = new ParseField("cluster_term");
     private static final ParseField STATE_VERSION_FIELD = new ParseField("state_version");

diff --git a/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java b/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateService.java
@@ -797,6 +797,7 @@ private ClusterMetadataManifest uploadManifest(
                 uploadedTemplatesMetadata,
                 uploadedCustomMetadataMap,
                 clusterState.routingTable().version(),
+                // TODO: Add actual list of changed indices routing with index routing upload flow.
                 new ArrayList<>()
             );
             writeMetadataManifest(clusterState.getClusterName().value(), clusterState.metadata().clusterUUID(), manifest, manifestFileName);

diff --git a/server/src/main/java/org/opensearch/gateway/remote/routingtable/RemoteIndexRoutingTable.java b/server/src/main/java/org/opensearch/gateway/remote/routingtable/RemoteIndexRoutingTable.java
@@ -32,6 +32,12 @@ public RemoteIndexRoutingTable(IndexRoutingTable indexRoutingTable) {
         this.indexRoutingTable = indexRoutingTable;
     }
 
+    /**
+     * Reads data from inputStream and creates RemoteIndexRoutingTable object with the {@link IndexRoutingTable}
+     * @param inputStream
+     * @param index
+     * @throws IOException
+     */
     public RemoteIndexRoutingTable(InputStream inputStream, Index index) throws IOException {
         try {
             try (BufferedChecksumStreamInput in = new BufferedChecksumStreamInput(new InputStreamStreamInput(inputStream), "assertion")) {
@@ -57,6 +63,11 @@ public IndexRoutingTable getIndexRoutingTable() {
         return indexRoutingTable;
     }
 
+    /**
+     * Writes {@link IndexRoutingTable} to the given stream
+     * @param streamOutput
+     * @throws IOException
+     */
     @Override
     public void writeTo(StreamOutput streamOutput) throws IOException {
         try {