SftpReadSettings Class

Sftp read settings.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.datafactory.models._models_py3.StoreReadSettings

SftpReadSettings

Constructor

SftpReadSettings(*, additional_properties: Optional[Dict[str, Any]] = None, max_concurrent_connections: Optional[Any] = None, disable_metrics_collection: Optional[Any] = None, recursive: Optional[Any] = None, wildcard_folder_path: Optional[Any] = None, wildcard_file_name: Optional[Any] = None, enable_partition_discovery: Optional[bool] = None, partition_root_path: Optional[Any] = None, file_list_path: Optional[Any] = None, delete_files_after_completion: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, disable_chunking: Optional[Any] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. The read setting type.Constant filled by server.

max_concurrent_connections

any

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

disable_metrics_collection

any

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

recursive

any

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

wildcard_folder_path

any

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

wildcard_file_name

any

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

enable_partition_discovery

bool

Indicates whether to enable partition discovery.

partition_root_path

any

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

file_list_path

any

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).

delete_files_after_completion

any

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

modified_datetime_start

any

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

modified_datetime_end

any

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

disable_chunking

any

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