Deprecating DataLakeFileClient.flush(long) to avoid confusing behavior (

Azure#33036)
azure-sdk · Jan 19, 2023 · 57f7a01 · 57f7a01
1 parent c003d74
commit 57f7a01
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/sdk/storage/azure-storage-file-datalake/CHANGELOG.md b/sdk/storage/azure-storage-file-datalake/CHANGELOG.md
@@ -11,6 +11,7 @@
 ### Bugs Fixed
 
 ### Other Changes
+- Deprecated the always-failing API `DataLakeFileClient.flush(long)` to avoid confusion regarding overwrite semantics in DataLake.
 
 ## 12.13.2 (2023-01-10)
 

diff --git a/...-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeFileAsyncClient.java b/...-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeFileAsyncClient.java
@@ -1199,10 +1199,11 @@ Mono<Response<Void>> appendWithResponse(Flux<ByteBuffer> data, long fileOffset,
      * Docs</a></p>
      *
      * @param position The length of the file after all data has been written.
-     *
      * @return A reactive response containing the information of the created resource.
+     * @deprecated See {@link #flush(long, boolean)} instead.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
+    @Deprecated
     public Mono<PathInfo> flush(long position) {
         return flush(position, false);
     }

diff --git a/...orage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeFileClient.java b/...orage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeFileClient.java
@@ -868,10 +868,11 @@ public Response<Void> appendWithResponse(BinaryData data, long fileOffset,
      * Docs</a></p>
      *
      * @param position The length of the file after all data has been written.
-     *
      * @return Information about the created resource.
+     * @deprecated See {@link #flush(long, boolean)} instead.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
+    @Deprecated
     public PathInfo flush(long position) {
         return flush(position, false);
     }