DataLakeFileFlushOptions Class

Definition

Namespace:

Azure.Storage.Files.DataLake.Models

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.21.0

Source:

DataLakeFileFlushOptions.cs

Optional parameters for appending data to a file with DataLakeFileClient.Flush() and .FlushAsync().

public class DataLakeFileFlushOptions

type DataLakeFileFlushOptions = class

Public Class DataLakeFileFlushOptions

Inheritance

Object

DataLakeFileFlushOptions

Constructors

DataLakeFileFlushOptions()

Properties

Close	Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."
Conditions	Optional DataLakeRequestConditions to add conditions on the flush of this file.
HttpHeaders	Optional standard HTTP header properties that can be set for the file.
LeaseAction	Lease action. Acquire will attempt to aquire a new lease on the file, with ProposedLeaseId as the lease ID. AcquireRelease will attempt to aquire a new lease on the file, with ProposedLeaseId as the lease ID. The lease will be released once the Append operation is complete. AutoRenew will attempt to renew the lease specified by LeaseId. Release will attempt to release the least speified by LeaseId.
LeaseDuration	Specifies the duration of the lease, in seconds, or specify InfiniteLeaseDuration for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds.
ProposedLeaseId	Proposed lease ID. Valid with Acquire and AcquireRelease.
RetainUncommittedData	If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.