TransferParameters Constructor

Definition

Namespace:

Microsoft.Azure.Management.DataLake.Store

Assembly:

Microsoft.Azure.Management.DataLake.Store.dll

Package:

Microsoft.Azure.Management.DataLake.Store v2.2.1

Creates a new set of parameters for the DataLakeStoreTransferClient.

public TransferParameters (string inputFilePath, string targetStreamPath, string accountName, int perFileThreadCount = -1, int concurrentFileCount = -1, bool isOverwrite = false, bool isResume = false, bool isBinary = true, bool isRecursive = false, bool isDownload = false, long maxSegmentLength = 268435456, string localMetadataLocation = default);

new Microsoft.Azure.Management.DataLake.Store.TransferParameters : string * string * string * int * int * bool * bool * bool * bool * bool * int64 * string -> Microsoft.Azure.Management.DataLake.Store.TransferParameters

Public Sub New (inputFilePath As String, targetStreamPath As String, accountName As String, Optional perFileThreadCount As Integer = -1, Optional concurrentFileCount As Integer = -1, Optional isOverwrite As Boolean = false, Optional isResume As Boolean = false, Optional isBinary As Boolean = true, Optional isRecursive As Boolean = false, Optional isDownload As Boolean = false, Optional maxSegmentLength As Long = 268435456, Optional localMetadataLocation As String = Nothing)

Parameters

inputFilePath

String

The full path to the file or folder to be transferred.

targetStreamPath

String

The full stream path where the file or folder will be transferred to.

accountName

String

Name of the account to transfer to.

perFileThreadCount

Int32

The per file thread count, indicating the number of file segments to transfer in parallel. This number is capped at FILE_SIZE/maxSegmentLength for optimal performance.

concurrentFileCount

Int32

The parallel file count, indicating the number of files to transfer in parallel during a folder transfer. This parameter is ignored for single file transfers. Default is 5 for folder transfers

isOverwrite

Boolean

(Optional) Whether to overwrite the target stream or not.

isResume

Boolean

(Optional) Indicates whether to resume a previously interrupted transfer.

isBinary

Boolean

(Optional) Indicates whether to treat the input file as a binary file (true), or whether to align transfer blocks to record boundaries (false).

isRecursive

Boolean

(Optional) Indicates whether to transfer the source folder recursively or not. If true, will transfer the source directory and all sub directories, preserving directory structure.

isDownload

Boolean

(Optional) if set to true [is download] instead of an transfer scenario. Default is false.

maxSegmentLength

Int64

Maximum length of each segment. The default is 256mb, which gives optimal performance. Modify at your own risk.

localMetadataLocation

String

(Optional) Indicates the directory path where to store the local transfer metadata file while the transfer is in progress. This location must be writeable from this application. Default location: SpecialFolder.LocalApplicationData.