Share via

FileFlushOptions interface

  • Reference
Package:
@azure/storage-file-datalake

An interface for options common to every remote operation.

Extends
CommonOptions

Properties

abortSignal
close
conditions
customerProvidedKey

Customer Provided Key Info.
leaseAction

Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release the lease only on flush. If "acquire-release" it will acquire & complete the operation & release the lease once operation is done.
leaseDurationInSeconds

The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.
pathHttpHeaders
proposedLeaseId

Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.
retainUncommittedData

Inherited Properties

tracingOptions

Property Details

abortSignal 

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

close 

close?: boolean

Property Value

boolean

conditions 

conditions?: DataLakeRequestConditions

Property Value

DataLakeRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

leaseAction

Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release the lease only on flush. If "acquire-release" it will acquire & complete the operation & release the lease once operation is done.

leaseAction?: LeaseAction

Property Value

LeaseAction

leaseDurationInSeconds

The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.

leaseDurationInSeconds?: number

Property Value

number

pathHttpHeaders 

pathHttpHeaders?: PathHttpHeaders

Property Value

PathHttpHeaders

proposedLeaseId

Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.

proposedLeaseId?: string

Property Value

string

retainUncommittedData 

retainUncommittedData?: boolean

Property Value

boolean

Inherited Property Details

tracingOptions 

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions