Addressed APIView Comments for GA of storage libraries (Azure#20934)

Author: gapra-msft

sdk/storage/azure-storage-blob-cryptography/src/main/java/com/azure/storage/blob/specialized/cryptography/EncryptedBlobClient.java

@@ -75,6 +75,9 @@ public class EncryptedBlobClient extends BlobClient {
 
     /**
      * Creates and opens an output stream to write data to the block blob.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @return A {@link BlobOutputStream} object used to write data to the blob.
      * @throws BlobStorageException If a storage service error occurred.
@@ -85,6 +88,9 @@ public BlobOutputStream getBlobOutputStream() {
 
     /**
      * Creates and opens an output stream to write data to the block blob.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @return A {@link BlobOutputStream} object used to write data to the blob.
      * @param overwrite Whether or not to overwrite, should data exist on the blob.
@@ -106,6 +112,9 @@ public BlobOutputStream getBlobOutputStream(boolean overwrite) {
      * will be overwritten.
      * <p>
      * To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @param parallelTransferOptions {@link ParallelTransferOptions} used to configure buffered uploading.
      * @param headers {@link BlobHttpHeaders}
@@ -130,7 +139,10 @@ public BlobOutputStream getBlobOutputStream(ParallelTransferOptions parallelTran
      * will be overwritten.
      * <p>
      * To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
-     *
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
+     * 
      * @param options {@link BlockBlobOutputStreamOptions}
      *
      * @return A {@link BlobOutputStream} object used to write data to the blob.

sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlockBlobClient.java

@@ -97,6 +97,9 @@ public final class BlockBlobClient extends BlobClientBase {
 
     /**
      * Creates and opens an output stream to write data to the block blob.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @return A {@link BlobOutputStream} object used to write data to the blob.
      * @throws BlobStorageException If a storage service error occurred.
@@ -107,6 +110,9 @@ public BlobOutputStream getBlobOutputStream() {
 
     /**
      * Creates and opens an output stream to write data to the block blob.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @return A {@link BlobOutputStream} object used to write data to the blob.
      * @param overwrite Whether or not to overwrite, should data exist on the blob.
@@ -128,6 +134,9 @@ public BlobOutputStream getBlobOutputStream(boolean overwrite) {
      * will be overwritten.
      * <p>
      * To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @param requestConditions A {@link BlobRequestConditions} object that represents the access conditions for the
      * blob.
@@ -144,6 +153,9 @@ public BlobOutputStream getBlobOutputStream(BlobRequestConditions requestConditi
      * will be overwritten.
      * <p>
      * To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @param parallelTransferOptions {@link ParallelTransferOptions} used to configure buffered uploading.
      * @param headers {@link BlobHttpHeaders}
@@ -168,6 +180,9 @@ public BlobOutputStream getBlobOutputStream(ParallelTransferOptions parallelTran
      * will be overwritten.
      * <p>
      * To avoid overwriting, pass "*" to {@link BlobRequestConditions#setIfNoneMatch(String)}.
+     * <p>
+     * Note: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream
+     * obtained below with a {@link java.io.BufferedOutputStream}.
      *
      * @param options {@link BlockBlobOutputStreamOptions}
      * @return A {@link BlobOutputStream} object used to write data to the blob.

sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemUndeleteOptions.java

@@ -10,7 +10,7 @@
  * Extended options that may be passed when restoring a file system.
  */
 @Fluent
-public class FileSystemUndeleteOptions {
+public final class FileSystemUndeleteOptions {
     private final String deletedFileSystemName;
     private final String deletedFileSystemVersion;
     private String destinationFileSystemName;