apiview feedback (Azure#27405)

* apiview feedback * Added tag
DarshanPathak45 · Mar 2, 2022 · 9d8bb10 · 9d8bb10
1 parent 8526649
commit 9d8bb10
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 20 deletions.
diff --git a/...age/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobContainerAsyncClient.java b/...age/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobContainerAsyncClient.java
@@ -1261,7 +1261,7 @@ private Mono<ContainersListBlobHierarchySegmentResponse> listBlobsHierarchySegme
 
     /**
      * Returns a reactive Publisher emitting the blobs in this container whose tags match the query expression. For more
-     * information, including information on the query syntax, see the <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/find-blobs-by-tags">Azure Docs</a>.
+     * information, including information on the query syntax, see the <a href="https://docs.microsoft.com/rest/api/storageservices/find-blobs-by-tags">Azure Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
      *
@@ -1281,7 +1281,7 @@ public PagedFlux<TaggedBlobItem> findBlobsByTags(String query) {
 
     /**
      * Returns a reactive Publisher emitting the blobs in this container whose tags match the query expression. For more
-     * information, including information on the query syntax, see the <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/find-blobs-by-tags">Azure Docs</a>.
+     * information, including information on the query syntax, see the <a href="https://docs.microsoft.com/rest/api/storageservices/find-blobs-by-tags">Azure Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
      *

diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobContainerClient.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/BlobContainerClient.java
@@ -848,7 +848,7 @@ public PagedIterable<BlobItem> listBlobsByHierarchy(String delimiter, ListBlobsO
     /**
      * Returns a lazy loaded list of blobs in this container whose tags match the query expression. The returned
      * {@link PagedIterable} can be consumed while new items are automatically retrieved as needed. For more
-     * information, including information on the query syntax, see the <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/find-blobs-by-tags">Azure Docs</a>.
+     * information, including information on the query syntax, see the <a href="https://docs.microsoft.com/rest/api/storageservices/find-blobs-by-tags">Azure Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
      *

diff --git a/...storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobErrorCode.java b/...storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobErrorCode.java
@@ -326,6 +326,12 @@ public final class BlobErrorCode extends ExpandableStringEnum<BlobErrorCode> {
     /** Static value SnapshotCountExceeded for BlobErrorCode. */
     public static final BlobErrorCode SNAPSHOT_COUNT_EXCEEDED = fromString("SnapshotCountExceeded");
 
+    /** Static value SnapshotOperationRateExceeded for BlobErrorCode.
+     * @deprecated Please use {@link BlobErrorCode#SNAPSHOT_OPERATION_RATE_EXCEEDED}
+     */
+    @Deprecated
+    public static final BlobErrorCode SNAPHOT_OPERATION_RATE_EXCEEDED = fromString("SnapshotOperationRateExceeded");
+
     /** Static value SnapshotOperationRateExceeded for BlobErrorCode. */
     public static final BlobErrorCode SNAPSHOT_OPERATION_RATE_EXCEEDED = fromString("SnapshotOperationRateExceeded");
 
@@ -369,9 +375,6 @@ public final class BlobErrorCode extends ExpandableStringEnum<BlobErrorCode> {
     public static final BlobErrorCode AUTHORIZATION_RESOURCE_TYPE_MISMATCH =
             fromString("AuthorizationResourceTypeMismatch");
 
-    /** Static value SnaphotOperationRateExceeded for BlobErrorCode. */
-    public static final BlobErrorCode SNAPHOT_OPERATION_RATE_EXCEEDED = fromString("SnaphotOperationRateExceeded");
-
     /**
      * Creates or finds a BlobErrorCode from its string representation.
      *

diff --git a/...rage-file-share/src/main/java/com/azure/storage/file/share/ShareDirectoryAsyncClient.java b/...rage-file-share/src/main/java/com/azure/storage/file/share/ShareDirectoryAsyncClient.java
@@ -993,7 +993,7 @@ PagedFlux<CloseHandlesInfo> forceCloseAllHandlesWithTimeout(boolean recursive, D
     /**
      * Moves the directory to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-directory">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-directory">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
@@ -1020,7 +1020,7 @@ public Mono<ShareDirectoryAsyncClient> rename(String destinationPath) {
     /**
      * Moves the directory to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-directory">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-directory">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
@@ -1088,7 +1088,7 @@ Mono<Response<ShareDirectoryAsyncClient>> renameWithResponse(ShareFileRenameOpti
                 .setFileAttributes(fileAttributes)
                 .setFileCreationTime(fileCreationTime)
                 .setFileLastWriteTime(fileLastWriteTime)
-                .setIgnoreReadOnly(options.getIgnoreReadOnly());
+                .setIgnoreReadOnly(options.isIgnoreReadOnly());
         }
 
         ShareDirectoryAsyncClient destinationDirectoryClient =
@@ -1101,7 +1101,7 @@ Mono<Response<ShareDirectoryAsyncClient>> renameWithResponse(ShareFileRenameOpti
 
         return destinationDirectoryClient.azureFileStorageClient.getDirectories().renameWithResponseAsync(
             destinationDirectoryClient.getShareName(), destinationDirectoryClient.getDirectoryPath(), renameSource,
-            null /* timeout */, options.getReplaceIfExists(), options.getIgnoreReadOnly(),
+            null /* timeout */, options.getReplaceIfExists(), options.isIgnoreReadOnly(),
             options.getFilePermission(), filePermissionKey, options.getMetadata(), sourceConditions,
             destinationConditions, smbInfo,
             context.addData(AZ_TRACING_NAMESPACE_KEY, STORAGE_TRACING_NAMESPACE_VALUE))

diff --git a/...e-storage-file-share/src/main/java/com/azure/storage/file/share/ShareDirectoryClient.java b/...e-storage-file-share/src/main/java/com/azure/storage/file/share/ShareDirectoryClient.java
@@ -717,7 +717,7 @@ public CloseHandlesInfo forceCloseAllHandles(boolean recursive, Duration timeout
     /**
      * Moves the directory to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-directory">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-directory">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
@@ -740,7 +740,7 @@ public ShareDirectoryClient rename(String destinationPath) {
     /**
      * Moves the directory to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-directory">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-directory">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>

diff --git a/...e-storage-file-share/src/main/java/com/azure/storage/file/share/ShareFileAsyncClient.java b/...e-storage-file-share/src/main/java/com/azure/storage/file/share/ShareFileAsyncClient.java
@@ -2855,7 +2855,7 @@ PagedFlux<CloseHandlesInfo> forceCloseAllHandlesWithOptionalTimeout(Duration tim
     /**
      * Moves the file to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-file">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-file">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
@@ -2882,7 +2882,7 @@ public Mono<ShareFileAsyncClient> rename(String destinationPath) {
     /**
      * Moves the file to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-file">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-file">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
@@ -2950,7 +2950,7 @@ Mono<Response<ShareFileAsyncClient>> renameWithResponse(ShareFileRenameOptions o
                 .setFileAttributes(fileAttributes)
                 .setFileCreationTime(fileCreationTime)
                 .setFileLastWriteTime(fileLastWriteTime)
-                .setIgnoreReadOnly(options.getIgnoreReadOnly());
+                .setIgnoreReadOnly(options.isIgnoreReadOnly());
         }
 
         ShareFileAsyncClient destinationFileClient = getFileAsyncClient(options.getDestinationPath());
@@ -2962,7 +2962,7 @@ Mono<Response<ShareFileAsyncClient>> renameWithResponse(ShareFileRenameOptions o
 
         return destinationFileClient.azureFileStorageClient.getFiles().renameWithResponseAsync(
             destinationFileClient.getShareName(), destinationFileClient.getFilePath(), renameSource,
-            null /* timeout */, options.getReplaceIfExists(), options.getIgnoreReadOnly(),
+            null /* timeout */, options.getReplaceIfExists(), options.isIgnoreReadOnly(),
             options.getFilePermission(), filePermissionKey, options.getMetadata(), sourceConditions,
             destinationConditions, smbInfo,
             context.addData(AZ_TRACING_NAMESPACE_KEY, STORAGE_TRACING_NAMESPACE_VALUE))

diff --git a/.../azure-storage-file-share/src/main/java/com/azure/storage/file/share/ShareFileClient.java b/.../azure-storage-file-share/src/main/java/com/azure/storage/file/share/ShareFileClient.java
@@ -2154,7 +2154,7 @@ public CloseHandlesInfo forceCloseAllHandles(Duration timeout, Context context)
     /**
      * Moves the file to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-file">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-file">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>
@@ -2177,7 +2177,7 @@ public ShareFileClient rename(String destinationPath) {
     /**
      * Moves the file to another location within the share.
      * For more information see the
-     * <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/rename-file">Azure
+     * <a href="https://docs.microsoft.com/rest/api/storageservices/rename-file">Azure
      * Docs</a>.
      *
      * <p><strong>Code Samples</strong></p>

diff --git a/...file-share/src/main/java/com/azure/storage/file/share/options/ShareFileRenameOptions.java b/...file-share/src/main/java/com/azure/storage/file/share/options/ShareFileRenameOptions.java
@@ -14,7 +14,7 @@
  * Extended options that may be passed when renaming a file or directory.
  */
 @Fluent
-public class ShareFileRenameOptions {
+public final class ShareFileRenameOptions {
 
     private final String destinationPath;
     private Boolean replaceIfExists;
@@ -69,7 +69,7 @@ public ShareFileRenameOptions setReplaceIfExists(Boolean replaceIfExists) {
      * respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly
      * attribute set will cause the rename to fail.
      */
-    public Boolean getIgnoreReadOnly() {
+    public Boolean isIgnoreReadOnly() {
         return ignoreReadOnly;
     }