Share via


MockAdlsClient.BulkDownload Method

Definition

Reads data from memory stream and save it to local file

public override Microsoft.Azure.DataLake.Store.FileTransfer.TransferStatus BulkDownload (string srcPath, string destPath, int numThreads = -1, Microsoft.Azure.DataLake.Store.IfExists shouldOverwrite = Microsoft.Azure.DataLake.Store.IfExists.Overwrite, IProgress<Microsoft.Azure.DataLake.Store.FileTransfer.TransferStatus> progressTracker = default, bool notRecurse = false, bool resume = false, System.Threading.CancellationToken cancelToken = default);
override this.BulkDownload : string * string * int * Microsoft.Azure.DataLake.Store.IfExists * IProgress<Microsoft.Azure.DataLake.Store.FileTransfer.TransferStatus> * bool * bool * System.Threading.CancellationToken -> Microsoft.Azure.DataLake.Store.FileTransfer.TransferStatus
Public Overrides Function BulkDownload (srcPath As String, destPath As String, Optional numThreads As Integer = -1, Optional shouldOverwrite As IfExists = Microsoft.Azure.DataLake.Store.IfExists.Overwrite, Optional progressTracker As IProgress(Of TransferStatus) = Nothing, Optional notRecurse As Boolean = false, Optional resume As Boolean = false, Optional cancelToken As CancellationToken = Nothing) As TransferStatus

Parameters

srcPath
String

Remote source path

destPath
String

Local destination path. It should always be a directory.

numThreads
Int32

Not used

shouldOverwrite
IfExists

Whether to overwrite or skip if the destination exists

progressTracker
IProgress<TransferStatus>

Not used

notRecurse
Boolean

Not used

resume
Boolean

Not used

cancelToken
CancellationToken

Returns

Transfer status encapsulating the details of download

Applies to