SftpReadSettings Class

Sftp read settings.

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

Constructor

SftpReadSettings(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, max_concurrent_connections: 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. Default value: None
max_concurrent_connections	<xref:JSON> The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). Default value: None
recursive	<xref:JSON> If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). Default value: None
wildcard_folder_path	<xref:JSON> Sftp wildcardFolderPath. Type: string (or Expression with resultType string). Default value: None
wildcard_file_name	<xref:JSON> Sftp wildcardFileName. Type: string (or Expression with resultType string). Default value: None
enable_partition_discovery	<xref:JSON> Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). Default value: None
partition_root_path	<xref:JSON> Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). Default value: None
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). Default value: None
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). Default value: None
modified_datetime_start	<xref:JSON> The start of file's modified datetime. Type: string (or Expression with resultType string). Default value: None
modified_datetime_end	<xref:JSON> The end of file's modified datetime. Type: string (or Expression with resultType string). Default value: None
disable_chunking	<xref:JSON> If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean). Default value: None

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

Methods

as_dict	Return a dict that can be serialized using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer If you want XML serialization, you can pass the kwargs is_xml=True.
deserialize	Parse a str using the RestAPI syntax and return a model.
enable_additional_properties_sending
from_dict	Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict

Return a dict that can be serialized using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name	Description
key_transformer	<xref:function> A key transformer function.
keep_readonly	Default value: True

Returns

Type	Description
dict	A dict JSON compatible object

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Required	str A str using RestAPI structure. JSON by default.
content_type	str JSON by default, set application/xml if XML. Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Required	dict A dict using RestAPI structure
content_type	str JSON by default, set application/xml if XML. Default value: None
key_extractors	Default value: None

Returns

Type	Description
	An instance of this model

Exceptions

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
keep_readonly	bool If you want to serialize the readonly attributes Default value: False

Returns

Type	Description
dict	A dict JSON compatible object