FileParallelUploadOptions interface
- Extends
Properties
| abort |
An implementation of the |
| chunk |
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. |
| customer |
Customer Provided Key Info. |
| encryption |
Specifies the encryption context to set on the file. |
| max |
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. |
| on |
Progress updater. |
| path |
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. |
| single |
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
| tracing |
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?: AbortSignalLikeProperty Value
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?: numberProperty 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?: booleanProperty Value
boolean
conditions
Access conditions headers.
conditions?: DataLakeRequestConditionsProperty Value
customerProvidedKey
encryptionContext
Specifies the encryption context to set on the file.
encryptionContext?: stringProperty 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?: numberProperty Value
number
metadata
A collection of key-value string pair to associate with the Data Lake file.
metadata?: MetadataProperty Value
onProgress
Progress updater.
onProgress?: (progress: TransferProgressEvent) => voidProperty Value
(progress: TransferProgressEvent) => void
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?: stringProperty 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?: numberProperty 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?: stringProperty Value
string