Share via

FileParallelUploadOptions interface

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

Option interface for Data Lake file - Upload operations

See:

Extends
CommonOptions

Properties

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
chunkSize

The size of data in bytes that will be transferred in parallel. If set to 0 or undefined, it will be automatically calculated according to the data size. Its max value is FILE_UPLOAD_MAX_CHUNK_SIZE.
close

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 (when close set to "false") and the final close of a file stream (when close set to "true").
conditions

Access conditions headers.
customerProvidedKey

Customer Provided Key Info.
encryptionContext

Specifies the encryption context to set on the file.
maxConcurrency

Max concurrency of parallel uploading. Must be greater than or equal to 0. Its default value is DEFAULT_HIGH_LEVEL_CONCURRENCY.
metadata

A collection of key-value string pair to associate with the Data Lake file.
onProgress

Progress updater.
pathHttpHeaders

Http headers.
permissions

Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.
singleUploadThreshold

Data size threshold in bytes to use a single upload operation rather than parallel uploading. Data of smaller size than this limit will be transferred in a single upload. Data larger than this limit will be transferred in chunks in parallel. Its default and max value is FILE_MAX_SINGLE_UPLOAD_THRESHOLD. Note: uploadStream do not respect this field and always do parallel uploading.
umask

The umask restricts the permissions of the file to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).

Inherited Properties

tracingOptions

Options to configure spans created when tracing is enabled.

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

chunkSize

The size of data in bytes that will be transferred in parallel. If set to 0 or undefined, it will be automatically calculated according to the data size. Its max value is FILE_UPLOAD_MAX_CHUNK_SIZE.

chunkSize?: number

Property Value

number

close

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 (when close set to "false") and the final close of a file stream (when close set to "true").

close?: boolean

Property Value

boolean

conditions

Access conditions headers.

conditions?: DataLakeRequestConditions

Property Value

DataLakeRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

encryptionContext

Specifies the encryption context to set on the file.

encryptionContext?: string

Property Value

string

maxConcurrency

Max concurrency of parallel uploading. Must be greater than or equal to 0. Its default value is DEFAULT_HIGH_LEVEL_CONCURRENCY.

maxConcurrency?: number

Property Value

number

metadata

A collection of key-value string pair to associate with the Data Lake file.

metadata?: Metadata

Property Value

Metadata

onProgress

Progress updater.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

pathHttpHeaders

Http headers.

pathHttpHeaders?: PathHttpHeaders

Property Value

PathHttpHeaders

permissions

Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.

permissions?: string

Property Value

string

singleUploadThreshold

Data size threshold in bytes to use a single upload operation rather than parallel uploading. Data of smaller size than this limit will be transferred in a single upload. Data larger than this limit will be transferred in chunks in parallel. Its default and max value is FILE_MAX_SINGLE_UPLOAD_THRESHOLD. Note: uploadStream do not respect this field and always do parallel uploading.

singleUploadThreshold?: number

Property Value

number

umask

The umask restricts the permissions of the file to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).

umask?: string

Property Value

string

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions