Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileParallelUploadOptions

Package version

Option interface for Data Lake file - Upload operations

See:

Hierarchy

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

Optional chunkSize

chunkSize: undefined | number

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.

Optional close

close: undefined | false | true

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").

Optional conditions

Access conditions headers.

Optional maxConcurrency

maxConcurrency: undefined | number

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

Optional metadata

metadata: Metadata

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

Optional onProgress

onProgress: undefined | ((progress: TransferProgressEvent) => void)

Progress updater.

Optional pathHttpHeaders

pathHttpHeaders: PathHttpHeaders

Http headers.

Optional permissions

permissions: undefined | string

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.

Optional singleUploadThreshold

singleUploadThreshold: undefined | number

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: DataLakeFileClient.uploadStream do not respect this field and always do parallel uploading.

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.

Optional umask

umask: undefined | string

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).

Generated using TypeDoc