DataLakeFileClient.Flush Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.20.1

Source:

DataLakeFileClient.cs

The Flush(Int64, DataLakeFileFlushOptions, CancellationToken) operation flushes (writes) previously appended data to a file.

public virtual Azure.Response<Azure.Storage.Files.DataLake.Models.PathInfo> Flush (long position, Azure.Storage.Files.DataLake.Models.DataLakeFileFlushOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Flush : int64 * Azure.Storage.Files.DataLake.Models.DataLakeFileFlushOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.PathInfo>
override this.Flush : int64 * Azure.Storage.Files.DataLake.Models.DataLakeFileFlushOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Files.DataLake.Models.PathInfo>

Public Overridable Function Flush (position As Long, Optional options As DataLakeFileFlushOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PathInfo)

Parameters

position

Int64

This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.

options

DataLakeFileFlushOptions

Optional parameters.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Response<PathInfo>

A Response<T> describing the path.

Remarks

A RequestFailedException will be thrown if a failure occurs.