Click or drag to resize

VEngineDownloadAsync Method
Efficiently downloads all or selected blobs in a job's Azure container to a local folder.

Namespace: RCS.Carbon.Variables
Assembly: RCS.Carbon.Variables (in RCS.Carbon.Variables.dll) Version: 9.0.12
Syntax
C#
Copy
public Task<JobDownloadResults> DownloadAsync(
	JobDownloadParameters parameters
)

Parameters

parameters  JobDownloadParameters

Return Value

TaskJobDownloadResults
Detailed information about the amount of data downloaded and the timing.
Exceptions
ExceptionCondition
CarbonExceptionThrown if the Carbon engine is not in the correct state to allow a download to proceed.
ArgumentNullExceptionThrown if parameters Destination value is null.
Remarks
The method would normally use the modern Parallel.ForEachAsync for highest performance and code simplicity, but this library must support Standard 2.0 and so it falls back to using a ConcurrentQueueT with multiple threads randomly pulling items out of the collection. The number of threads can be one to the processor count, with a default of 4, which was chosen via guesswork.
See Also