Share via


SftpReadSettings Class

Definition

Sftp read settings.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SftpReadSettings+SftpReadSettingsConverter))]
public class SftpReadSettings : Azure.Analytics.Synapse.Artifacts.Models.StoreReadSettings
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.SftpReadSettings+SftpReadSettingsConverter))>]
type SftpReadSettings = class
    inherit StoreReadSettings
Public Class SftpReadSettings
Inherits StoreReadSettings
Inheritance
SftpReadSettings
Attributes

Constructors

SftpReadSettings()

Initializes a new instance of SftpReadSettings.

Properties

AdditionalProperties

Additional Properties.

(Inherited from StoreReadSettings)
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).

MaxConcurrentConnections

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

(Inherited from StoreReadSettings)
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).

WildcardFileName

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

WildcardFolderPath

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

Applies to