Share via

SftpReadSettings interface

  • Reference
Package:
@azure/arm-datafactory

Sftp read settings.

Extends
StoreReadSettings

Properties

deleteFilesAfterCompletion

Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).
disableChunking

If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).
enablePartitionDiscovery

Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
fileListPath

Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).
modifiedDatetimeEnd

The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart

The start of file's modified datetime. Type: string (or Expression with resultType string).
partitionRootPath

Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
recursive

If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
type

Polymorphic discriminator, which specifies the different types this object can be
wildcardFileName

Sftp wildcardFileName. Type: string (or Expression with resultType string).
wildcardFolderPath

Sftp wildcardFolderPath. Type: string (or Expression with resultType string).

Inherited Properties

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
maxConcurrentConnections

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Property Details

deleteFilesAfterCompletion

Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean).

deleteFilesAfterCompletion?: any

Property Value

any

disableChunking

If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).

disableChunking?: any

Property Value

any

enablePartitionDiscovery

Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

enablePartitionDiscovery?: any

Property Value

any

fileListPath

Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string).

fileListPath?: any

Property Value

any

modifiedDatetimeEnd

The end of file's modified datetime. Type: string (or Expression with resultType string).

modifiedDatetimeEnd?: any

Property Value

any

modifiedDatetimeStart

The start of file's modified datetime. Type: string (or Expression with resultType string).

modifiedDatetimeStart?: any

Property Value

any

partitionRootPath

Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

partitionRootPath?: any

Property Value

any

recursive

If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).

recursive?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SftpReadSettings"

Property Value

"SftpReadSettings"

wildcardFileName

Sftp wildcardFileName. Type: string (or Expression with resultType string).

wildcardFileName?: any

Property Value

any

wildcardFolderPath

Sftp wildcardFolderPath. Type: string (or Expression with resultType string).

wildcardFolderPath?: any

Property Value

any

Inherited Property Details

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

disableMetricsCollection?: any

Property Value

any

Inherited From StoreReadSettings.disableMetricsCollection

maxConcurrentConnections

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

maxConcurrentConnections?: any

Property Value

any

Inherited From StoreReadSettings.maxConcurrentConnections