resolve comments

Signed-off-by: Sandeep Kumawat <[email protected]>
skumawat2025 · Apr 4, 2024 · 929482e · 929482e
1 parent 477fada
commit 929482e
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java b/server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java
@@ -32,6 +32,7 @@
 
 package org.opensearch.common.blobstore;
 
+import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.core.action.ActionListener;
 
 import java.io.IOException;
@@ -86,8 +87,9 @@ public interface BlobContainer {
      * @throws  NoSuchFileException if the blob does not exist
      * @throws  IOException if the blob can not be read.
      */
+    @ExperimentalApi
     default BlobDownloadResponse readBlobWithMetadata(String blobName) throws IOException {
-        return null;
+        throw new UnsupportedOperationException("readBlobWithMetadata is not implemented yet");
     };
 
     /**
@@ -160,13 +162,16 @@ default long readBlobPreferredLength() {
      * @throws  FileAlreadyExistsException if failIfAlreadyExists is true and a blob by the same name already exists
      * @throws  IOException if the input stream could not be read, or the target blob could not be written to.
      */
+    @ExperimentalApi
     default void writeBlobWithMetadata(
         String blobName,
         InputStream inputStream,
         Map<String, String> metadata,
         long blobSize,
         boolean failIfAlreadyExists
-    ) throws IOException {};
+    ) throws IOException {
+        throw new UnsupportedOperationException("writeBlobWithMetadata is not implemented yet");
+    };
 
     /**
      * Reads blob content from the input stream and writes it to the container in a new blob with the given name,
@@ -210,13 +215,16 @@ default void writeBlobWithMetadata(
      * @throws  FileAlreadyExistsException if failIfAlreadyExists is true and a blob by the same name already exists
      * @throws  IOException if the input stream could not be read, or the target blob could not be written to.
      */
+    @ExperimentalApi
     default void writeBlobAtomicWithMetadata(
         String blobName,
         InputStream inputStream,
         Map<String, String> metadata,
         long blobSize,
         boolean failIfAlreadyExists
-    ) throws IOException {};
+    ) throws IOException {
+        throw new UnsupportedOperationException("writeBlobAtomicWithMetadata is not implemented yet");
+    };
 
     /**
      * Deletes this container and all its contents from the repository.

diff --git a/server/src/main/java/org/opensearch/common/blobstore/BlobDownloadResponse.java b/server/src/main/java/org/opensearch/common/blobstore/BlobDownloadResponse.java
@@ -12,7 +12,8 @@
 import java.util.Map;
 
 /**
- * A class for blob download response
+ * Represents the response from a blob download operation, containing both the
+ * input stream of the blob content and the associated metadata.
  *
  * @opensearch.internal
  */
@@ -21,12 +22,12 @@ public class BlobDownloadResponse {
     /**
      * Downloaded blob InputStream
      */
-    private InputStream inputStream;
+    private final InputStream inputStream;
 
     /**
      * Metadata of the downloaded blob
      */
-    private Map<String, String> metadata;
+    private final Map<String, String> metadata;
 
     public InputStream getInputStream() {
         return inputStream;

diff --git a/server/src/main/java/org/opensearch/index/translog/transfer/TransferService.java b/server/src/main/java/org/opensearch/index/translog/transfer/TransferService.java
@@ -8,6 +8,7 @@
 
 package org.opensearch.index.translog.transfer;
 
+import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.common.blobstore.BlobDownloadResponse;
 import org.opensearch.common.blobstore.BlobMetadata;
 import org.opensearch.common.blobstore.BlobPath;
@@ -133,6 +134,7 @@ void uploadBlobs(
      * @return {@link BlobDownloadResponse} of the remote file
      * @throws IOException the exception while reading the data
      */
+    @ExperimentalApi
     BlobDownloadResponse downloadBlobWithMetadata(Iterable<String> path, String fileName) throws IOException;
 
     void listAllInSortedOrder(Iterable<String> path, String filenamePrefix, int limit, ActionListener<List<BlobMetadata>> listener);