Updated spec headers doc

khandelwal-ayush · Jun 12, 2024 · db7c653 · db7c653
1 parent 3c2c704
commit db7c653
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/samza-azure/src/main/java/org/apache/samza/system/azureblob/BlobClientBuilder.java b/samza-azure/src/main/java/org/apache/samza/system/azureblob/BlobClientBuilder.java
@@ -27,7 +27,8 @@
  */
 public interface BlobClientBuilder {
   /**
-   * create a client for ABS (uploads)
+   * Create a client for uploading to Azure Blob Storage
+   * @return New instance of {@link BlobServiceAsyncClient}
    */
   BlobServiceAsyncClient getBlobServiceAsyncClient();
 }
diff --git a/samza-azure/src/main/java/org/apache/samza/system/azureblob/BlobClientBuilderFactory.java b/samza-azure/src/main/java/org/apache/samza/system/azureblob/BlobClientBuilderFactory.java
@@ -25,9 +25,10 @@
 public interface BlobClientBuilderFactory {
   /**
    * Create a new instance of {@link BlobClientBuilder}
-   * @param systemName Name of the system
-   * @param azureUrlFormat Azure URL format
-   * @param azureBlobConfig Azure Blob configuration
+   * @param systemName Name of the system for which the blob client builder is being created
+   * @param azureUrlFormat The format of the Azure URL, which should conform to Azure's URL formatting requirements.
+   * @param azureBlobConfig The configuration settings for Azure Blob, encapsulated in an {@link AzureBlobConfig} object.
+   *                        This includes metadata details for Azure Blob configs.
    * @return New instance of {@link BlobClientBuilder}
    */
   BlobClientBuilder getBlobClientBuilder(String systemName, String azureUrlFormat, AzureBlobConfig azureBlobConfig);