Partilhar via


SftpReadSettings Class

Definition

Sftp read settings.

public class SftpReadSettings : Azure.ResourceManager.DataFactory.Models.StoreReadSettings, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.SftpReadSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.SftpReadSettings>
public class SftpReadSettings : Azure.ResourceManager.DataFactory.Models.StoreReadSettings
type SftpReadSettings = class
    inherit StoreReadSettings
    interface IJsonModel<SftpReadSettings>
    interface IPersistableModel<SftpReadSettings>
type SftpReadSettings = class
    inherit StoreReadSettings
Public Class SftpReadSettings
Inherits StoreReadSettings
Implements IJsonModel(Of SftpReadSettings), IPersistableModel(Of SftpReadSettings)
Public Class SftpReadSettings
Inherits StoreReadSettings
Inheritance
SftpReadSettings
Implements

Constructors

SftpReadSettings()

Initializes a new instance of SftpReadSettings.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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

DisableMetricsCollection

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

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from StoreReadSettings)

Explicit Interface Implementations

IJsonModel<SftpReadSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SftpReadSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<StoreReadSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from StoreReadSettings)
IJsonModel<StoreReadSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from StoreReadSettings)
IPersistableModel<SftpReadSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SftpReadSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SftpReadSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<StoreReadSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from StoreReadSettings)
IPersistableModel<StoreReadSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from StoreReadSettings)
IPersistableModel<StoreReadSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from StoreReadSettings)

Applies to