Skip to content

Commit d5300a2

Browse files
Fix javadocs for encoded url (#46213)
* fix javadocs to reflect that `blobName`s should not be URL This matches up with https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/storage/azure-storage-blob/CHANGELOG.md#breaking-changes-1 * fix javadocs to match nonencoded name for url
1 parent 07afd19 commit d5300a2

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobContainerAsyncClient.java

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,7 @@ public final class BlobContainerAsyncClient {
164164
* </pre>
165165
* <!-- end com.azure.storage.blob.BlobContainerAsyncClient.getBlobAsyncClient#String -->
166166
*
167-
* @param blobName A {@code String} representing the name of the blob. If the blob name contains special characters,
168-
* pass in the url encoded version of the blob name.
167+
* @param blobName A {@code String} representing the name of the blob. This should not be encoded.
169168
* @return A new {@link BlobAsyncClient} object which references the blob with the specified name in this container.
170169
*/
171170
public BlobAsyncClient getBlobAsyncClient(String blobName) {
@@ -184,8 +183,7 @@ public BlobAsyncClient getBlobAsyncClient(String blobName) {
184183
* </pre>
185184
* <!-- end com.azure.storage.blob.BlobContainerAsyncClient.getBlobAsyncClient#String-String -->
186185
*
187-
* @param blobName A {@code String} representing the name of the blob. If the blob name contains special characters,
188-
* pass in the url encoded version of the blob name.
186+
* @param blobName A {@code String} representing the name of the blob. This should not be encoded.
189187
* @param snapshot the snapshot identifier for the blob.
190188
* @return A new {@link BlobAsyncClient} object which references the blob with the specified name in this container.
191189
*/
@@ -198,8 +196,7 @@ public BlobAsyncClient getBlobAsyncClient(String blobName, String snapshot) {
198196
* Creates a new BlobAsyncClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new
199197
* BlobAsyncClient uses the same request policy pipeline as the ContainerAsyncClient.
200198
*
201-
* @param blobName A {@code String} representing the name of the blob. If the blob name contains special characters,
202-
* pass in the url encoded version of the blob name.
199+
* @param blobName A {@code String} representing the name of the blob. This should not be encoded.
203200
* @param versionId the version identifier for the blob, pass {@code null} to interact with the latest blob version.
204201
* @return A new {@link BlobAsyncClient} object which references the blob with the specified name in this container.
205202
*/

sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobContainerClient.java

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,7 @@ public final class BlobContainerClient {
150150
* Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new
151151
* BlobClient uses the same request policy pipeline as the ContainerAsyncClient.
152152
*
153-
* @param blobName A {@code String} representing the name of the blob. If the blob name contains special characters,
154-
* pass in the url encoded version of the blob name.
155-
*
153+
* @param blobName A {@code String} representing the name of the blob. This should not be encoded.
156154
* <p><strong>Code Samples</strong></p>
157155
*
158156
* <!-- src_embed com.azure.storage.blob.BlobContainerClient.getBlobClient#String -->
@@ -178,8 +176,7 @@ public BlobClient getBlobClient(String blobName) {
178176
* </pre>
179177
* <!-- end com.azure.storage.blob.BlobContainerClient.getBlobClient#String-String -->
180178
*
181-
* @param blobName A {@code String} representing the name of the blob. If the blob name contains special characters,
182-
* pass in the url encoded version of the blob name.
179+
* @param blobName A {@code String} representing the name of the blob. This should not be encoded.
183180
* @param snapshot the snapshot identifier for the blob.
184181
* @return A new {@link BlobClient} object which references the blob with the specified name in this container.
185182
*/
@@ -192,8 +189,7 @@ public BlobClient getBlobClient(String blobName, String snapshot) {
192189
* Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new
193190
* BlobClient uses the same request policy pipeline as the ContainerAsyncClient.
194191
*
195-
* @param blobName A {@code String} representing the name of the blob. If the blob name contains special characters,
196-
* pass in the url encoded version of the blob name.
192+
* @param blobName A {@code String} representing the name of the blob. This should not be encoded.
197193
* @param versionId the version identifier for the blob, pass {@code null} to interact with the latest blob version.
198194
* @return A new {@link BlobClient} object which references the blob with the specified name in this container.
199195
*/

0 commit comments

Comments
 (0)