SftpWriteSettings Class

Definition

Sftp write settings.

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

Constructors

SftpWriteSettings()

Initializes a new instance of SftpWriteSettings.

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 StoreWriteSettings)
CopyBehavior

The type of copy behavior for copy sink.

(Inherited from StoreWriteSettings)
DisableMetricsCollection

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

(Inherited from StoreWriteSettings)
MaxConcurrentConnections

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

(Inherited from StoreWriteSettings)
Metadata

Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects).

(Inherited from StoreWriteSettings)
OperationTimeout

Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string).

UseTempFileRename

Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean).

Methods

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

Explicit Interface Implementations

IJsonModel<SftpWriteSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<SftpWriteSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<StoreWriteSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from StoreWriteSettings)
IPersistableModel<SftpWriteSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SftpWriteSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<SftpWriteSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<StoreWriteSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from StoreWriteSettings)

Applies to