rename BlobDownloadResponse to FetchBlobResults

Signed-off-by: Sandeep Kumawat <2025sandeepkumawat@gmail.com>

plugins/repository-s3/src/main/java/org/opensearch/repositories/s3/S3BlobContainer.java

@@ -73,11 +73,11 @@
 import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.common.blobstore.AsyncMultiStreamBlobContainer;
 import org.opensearch.common.blobstore.BlobContainer;
-import org.opensearch.common.blobstore.BlobDownloadResponse;
 import org.opensearch.common.blobstore.BlobMetadata;
 import org.opensearch.common.blobstore.BlobPath;
 import org.opensearch.common.blobstore.BlobStoreException;
 import org.opensearch.common.blobstore.DeleteResult;
+import org.opensearch.common.blobstore.FetchBlobResult;
 import org.opensearch.common.blobstore.stream.read.ReadContext;
 import org.opensearch.common.blobstore.stream.write.WriteContext;
 import org.opensearch.common.blobstore.stream.write.WritePriority;
@@ -141,9 +141,9 @@
 
     @ExperimentalApi
     @Override
-    public BlobDownloadResponse readBlobWithMetadata(String blobName) throws IOException {
+    public FetchBlobResult readBlobWithMetadata(String blobName) throws IOException {
         S3RetryingInputStream s3RetryingInputStream = new S3RetryingInputStream(blobStore, buildKey(blobName));
-        return new BlobDownloadResponse(s3RetryingInputStream, s3RetryingInputStream.getMetadata());
+        return new FetchBlobResult(s3RetryingInputStream, s3RetryingInputStream.getMetadata());
     }
 
     @Override
@@ -343,8 +343,8 @@
         long blobSize,
         boolean failIfAlreadyExists
     ) throws IOException {
         writeBlobWithMetadata(blobName, inputStream, metadata, blobSize, failIfAlreadyExists);
     }
 
     @Override
     public DeleteResult delete() throws IOException {

plugins/repository-s3/src/test/java/org/opensearch/repositories/s3/async/AsyncTransferManagerTests.java

@@ -40,7 +40,9 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Executors;
@@ -78,11 +80,14 @@ public void testOneChunkUpload() {
         );
 
         AtomicReference<InputStream> streamRef = new AtomicReference<>();
+        Map<String, String> metadata = new HashMap<>();
+        metadata.put("key1", "value1");
+        metadata.put("key2", "value2");
         CompletableFuture<Void> resultFuture = asyncTransferManager.uploadObject(
             s3AsyncClient,
             new UploadRequest("bucket", "key", ByteSizeUnit.MB.toBytes(1), WritePriority.HIGH, uploadSuccess -> {
                 // do nothing
-            }, false, null, true, null),
+            }, false, null, true, metadata),
             new StreamContext((partIdx, partSize, position) -> {
                 streamRef.set(new ZeroInputStream(partSize));
                 return new InputStreamContainer(streamRef.get(), partSize, position);
@@ -123,11 +128,15 @@ public void testOneChunkUploadCorruption() {
         deleteObjectResponseCompletableFuture.complete(DeleteObjectResponse.builder().build());
         when(s3AsyncClient.deleteObject(any(DeleteObjectRequest.class))).thenReturn(deleteObjectResponseCompletableFuture);
 
+        Map<String, String> metadata = new HashMap<>();
+        metadata.put("key1", "value1");
+        metadata.put("key2", "value2");
+
         CompletableFuture<Void> resultFuture = asyncTransferManager.uploadObject(
             s3AsyncClient,
             new UploadRequest("bucket", "key", ByteSizeUnit.MB.toBytes(1), WritePriority.HIGH, uploadSuccess -> {
                 // do nothing
-            }, false, null, true, null),
+            }, false, null, true, metadata),
             new StreamContext(
                 (partIdx, partSize, position) -> new InputStreamContainer(new ZeroInputStream(partSize), partSize, position),
                 ByteSizeUnit.MB.toBytes(1),
@@ -180,7 +189,7 @@ public void testMultipartUpload() {
             s3AsyncClient,
             new UploadRequest("bucket", "key", ByteSizeUnit.MB.toBytes(5), WritePriority.HIGH, uploadSuccess -> {
                 // do nothing
-            }, true, 3376132981L, true, null),
+            }, true, 3376132981L, true, new HashMap<>()),
             new StreamContext((partIdx, partSize, position) -> {
                 InputStream stream = new ZeroInputStream(partSize);
                 streams.add(stream);

server/src/main/java/org/opensearch/common/blobstore/BlobContainer.java

@@ -80,16 +80,16 @@ public interface BlobContainer {
     InputStream readBlob(String blobName) throws IOException;
 
     /**
-     * Creates a new {@link BlobDownloadResponse} for the given blob name.
+     * Creates a new {@link FetchBlobResult} for the given blob name.
      *
      * @param   blobName
      *          The name of the blob to get an {@link InputStream} for.
-     * @return  The {@link BlobDownloadResponse} of the blob.
+     * @return  The {@link FetchBlobResult} of the blob.
      * @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 {
+    default FetchBlobResult readBlobWithMetadata(String blobName) throws IOException {
         throw new UnsupportedOperationException("readBlobWithMetadata is not implemented yet");
     };
 

server/src/main/java/org/opensearch/common/blobstore/BlobDownloadResponse.java → server/src/main/java/org/opensearch/common/blobstore/FetchBlobResult.java

@@ -17,7 +17,7 @@
  *
  * @opensearch.experimental
  */
-public class BlobDownloadResponse {
+public class FetchBlobResult {
 
     /**
      * Downloaded blob InputStream
@@ -37,7 +37,7 @@
         return metadata;
     }
 
-    public BlobDownloadResponse(InputStream inputStream, Map<String, String> metadata) {
+    public FetchBlobResult(InputStream inputStream, Map<String, String> metadata) {
         this.inputStream = inputStream;
         this.metadata = metadata;
     }

server/src/main/java/org/opensearch/index/translog/transfer/BlobStoreTransferService.java

@@ -15,10 +15,10 @@
 import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.common.blobstore.AsyncMultiStreamBlobContainer;
 import org.opensearch.common.blobstore.BlobContainer;
-import org.opensearch.common.blobstore.BlobDownloadResponse;
 import org.opensearch.common.blobstore.BlobMetadata;
 import org.opensearch.common.blobstore.BlobPath;
 import org.opensearch.common.blobstore.BlobStore;
+import org.opensearch.common.blobstore.FetchBlobResult;
 import org.opensearch.common.blobstore.stream.write.WriteContext;
 import org.opensearch.common.blobstore.stream.write.WritePriority;
 import org.opensearch.common.blobstore.transfer.RemoteTransferContainer;
@@ -168,7 +168,7 @@ public InputStream downloadBlob(Iterable<String> path, String fileName) throws I
 
     @Override
     @ExperimentalApi
-    public BlobDownloadResponse downloadBlobWithMetadata(Iterable<String> path, String fileName) throws IOException {
+    public FetchBlobResult downloadBlobWithMetadata(Iterable<String> path, String fileName) throws IOException {
         return blobStore.blobContainer((BlobPath) path).readBlobWithMetadata(fileName);
     }
 

server/src/main/java/org/opensearch/index/translog/transfer/TransferService.java

@@ -9,9 +9,9 @@
 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;
+import org.opensearch.common.blobstore.FetchBlobResult;
 import org.opensearch.common.blobstore.stream.write.WritePriority;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.index.translog.transfer.FileSnapshot.TransferFileSnapshot;
@@ -131,11 +131,11 @@ void uploadBlobs(
      *
      * @param path  the remote path from where download should be made
      * @param fileName the name of the file
-     * @return {@link BlobDownloadResponse} of the remote file
+     * @return {@link FetchBlobResult} of the remote file
      * @throws IOException the exception while reading the data
      */
     @ExperimentalApi
-    BlobDownloadResponse downloadBlobWithMetadata(Iterable<String> path, String fileName) throws IOException;
+    FetchBlobResult downloadBlobWithMetadata(Iterable<String> path, String fileName) throws IOException;
 
     void listAllInSortedOrder(Iterable<String> path, String filenamePrefix, int limit, ActionListener<List<BlobMetadata>> listener);