From db7c653fcac1119d49102203ca7e9d12e36ddd1b Mon Sep 17 00:00:00 2001
From: Ayush Khandelwal <aykhandelwal@linkedin.com>
Date: Wed, 12 Jun 2024 21:28:54 +0530
Subject: [PATCH] Updated spec headers doc

---
 .../apache/samza/system/azureblob/BlobClientBuilder.java   | 3 ++-
 .../samza/system/azureblob/BlobClientBuilderFactory.java   | 7 ++++---
 2 files changed, 6 insertions(+), 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
index 52eb090efc..9bc3a5b199 100644
--- 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
index 438c307f9c..00d4cf94d1 100644
--- 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);