Fix build

Signed-off-by: Shivansh Arora <[email protected]>
opensearch-project · Jun 7, 2024 · eef8768 · eef8768
1 parent 9d73439
commit eef8768
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/gateway/remote/ClusterStateDiffManifest.java b/server/src/main/java/org/opensearch/gateway/remote/ClusterStateDiffManifest.java
@@ -29,6 +29,11 @@
 
 import static org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken;
 
+/**
+ * Manifest of diff between two cluster states
+ *
+ * @opensearch.internal
+ */
 public class ClusterStateDiffManifest implements ToXContentObject {
     private static final String FROM_STATE_UUID_FIELD = "from_state_uuid";
     private static final String TO_STATE_UUID_FIELD = "to_state_uuid";
@@ -494,6 +499,11 @@ public static Builder builder() {
         return new Builder();
     }
 
+    /**
+     * Builder for ClusterStateDiffManifest
+     *
+     * @opensearch.internal
+     */
     public static class Builder {
         private String fromStateUUID;
         private String toStateUUID;

diff --git a/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateAttributesManager.java b/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateAttributesManager.java
@@ -36,6 +36,11 @@
 import static org.opensearch.gateway.remote.RemoteClusterStateUtils.CUSTOM_DELIMITER;
 import static org.opensearch.gateway.remote.model.RemoteClusterStateCustoms.CLUSTER_STATE_CUSTOM;
 
+/**
+ * A Manager which provides APIs to upload and download attributes of ClusterState to the {@link RemoteClusterStateBlobStore}
+ *
+ * @opensearch.internal
+ */
 public class RemoteClusterStateAttributesManager {
     public static final String CLUSTER_STATE_ATTRIBUTE = "cluster_state_attribute";
     public static final String DISCOVERY_NODES = "nodes";

diff --git a/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateUtils.java b/server/src/main/java/org/opensearch/gateway/remote/RemoteClusterStateUtils.java
@@ -79,6 +79,9 @@ public RemoteStateTransferException(String errorDesc, Throwable cause) {
         }
     }
 
+    /**
+     * Container class to keep metadata of all uploaded attributes
+     */
     public static class UploadedMetadataResults {
         List<ClusterMetadataManifest.UploadedIndexMetadata> uploadedIndexMetadata;
         Map<String, ClusterMetadataManifest.UploadedMetadataAttribute> uploadedCustomMetadataMap;

diff --git a/server/src/main/java/org/opensearch/gateway/remote/model/RemoteClusterStateCustoms.java b/server/src/main/java/org/opensearch/gateway/remote/model/RemoteClusterStateCustoms.java
@@ -33,6 +33,9 @@
 import static org.opensearch.gateway.remote.RemoteClusterStateUtils.CUSTOM_DELIMITER;
 import static org.opensearch.gateway.remote.RemoteClusterStateUtils.DELIMITER;
 
+/**
+ * Wrapper class for uploading/downloading {@link Custom} to/from remote blob store
+ */
 public class RemoteClusterStateCustoms extends AbstractRemoteWritableBlobEntity<Custom> {
     public static final String CLUSTER_STATE_CUSTOM = "cluster-state-custom";
 

diff --git a/...r/src/main/java/org/opensearch/gateway/remote/model/RemoteHashesOfConsistentSettings.java b/...r/src/main/java/org/opensearch/gateway/remote/model/RemoteHashesOfConsistentSettings.java
@@ -29,6 +29,9 @@
 import static org.opensearch.gateway.remote.RemoteClusterStateUtils.DELIMITER;
 import static org.opensearch.gateway.remote.RemoteClusterStateUtils.GLOBAL_METADATA_PATH_TOKEN;
 
+/**
+ * Wrapper class for uploading/downloading {@link DiffableStringMap} to/from remote blob store
+ */
 public class RemoteHashesOfConsistentSettings extends AbstractRemoteWritableBlobEntity<DiffableStringMap> {
     public static final String HASHES_OF_CONSISTENT_SETTINGS = "hashes-of-consistent-settings";