SftpReadSettings Class

Sftp read settings.

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

Inheritance

azure.mgmt.datafactory.models._models_py3.StoreReadSettings

SftpReadSettings

Constructor

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

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
disable_metrics_collection	<xref:JSON> If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
recursive	<xref:JSON> If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
wildcard_folder_path	<xref:JSON> Sftp wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name	<xref:JSON> Sftp wildcardFileName. Type: string (or Expression with resultType string).
enable_partition_discovery	<xref:JSON> Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
partition_root_path	<xref:JSON> Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
file_list_path	<xref:JSON> 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	<xref:JSON> 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	<xref:JSON> The start of file's modified datetime. Type: string (or Expression with resultType string).
modified_datetime_end	<xref:JSON> The end of file's modified datetime. Type: string (or Expression with resultType string).
disable_chunking	<xref:JSON> If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str The read setting type. Required.
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
disable_metrics_collection	<xref:JSON> If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
recursive	<xref:JSON> If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean).
wildcard_folder_path	<xref:JSON> Sftp wildcardFolderPath. Type: string (or Expression with resultType string).
wildcard_file_name	<xref:JSON> Sftp wildcardFileName. Type: string (or Expression with resultType string).
enable_partition_discovery	<xref:JSON> Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).
partition_root_path	<xref:JSON> Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).
file_list_path	<xref:JSON> 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	<xref:JSON> 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	<xref:JSON> The start of file's modified datetime. Type: string (or Expression with resultType string).
modified_datetime_end	<xref:JSON> The end of file's modified datetime. Type: string (or Expression with resultType string).
disable_chunking	<xref:JSON> If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean).