Skip to main content

SftpDownloadNodeConfiguration

Namespace: Meshmakers.Octo.MeshAdapter.Nodes.Extract

Configuration node object for downloading one file from an SFTP server. Read counterpart of SftpUpload@1, which writes exactly one file.

public record SftpDownloadNodeConfiguration : TargetPathNodeConfiguration, INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<SftpDownloadNodeConfiguration>

Inheritance Object → NodeConfiguration → TargetPathNodeConfiguration → SftpDownloadNodeConfiguration
Implements INodeConfiguration, IEquatable<NodeConfiguration>, ITargetPathNodeConfiguration, IEquatable<TargetPathNodeConfiguration>, IEquatable<SftpDownloadNodeConfiguration>

Properties​

ServerConfiguration​

Name of the global configuration for the SFTP server

public string ServerConfiguration { get; set; }

Property Value​

String

RemotePath​

Static remote path of the file to read (set this or SftpDownloadNodeConfiguration.RemotePathPath)

public string RemotePath { get; set; }

Property Value​

String

RemotePathPath​

Path in the data context to resolve the remote path dynamically; takes precedence over SftpDownloadNodeConfiguration.RemotePath

public string RemotePathPath { get; set; }

Property Value​

String

MaxFileSizeBytes​

Largest remote file this node will read, in bytes. The file is held in memory and then decoded to a string, so the remote side would otherwise decide how much memory the adapter allocates - a multi-gigabyte file takes the pod down and comes back on the next tick. A file past the limit fails this one node; the rest of the run continues.

The default of 100 MiB is far above any text export these nodes exist for and still leaves the peak - roughly three times the file, between the buffer, the byte array and the decoded string - inside what an adapter pod is normally given. Raise it only as far as the pod's memory limit allows. There is no unlimited setting.

public long MaxFileSizeBytes { get; set; }

Property Value​

Int64

Encoding​

Encoding the remote file is written in (e.g. utf-8, windows-1252, iso-8859-1). Unknown names are rejected when the pipeline configuration is bound, so a typo fails the deployment instead of the first download.

public string Encoding { get; set; }

Property Value​

String

OnEncodingError​

How to handle bytes the configured encoding cannot represent: Replace substitutes the replacement character and logs a warning; Fail aborts the node, so no half-readable content travels downstream.

public EncodingErrorHandling OnEncodingError { get; set; }

Property Value​

EncodingErrorHandling

TargetPath​

public string TargetPath { get; set; }

Property Value​

String

TargetValueWriteMode​

public TargetValueWriteModes TargetValueWriteMode { get; set; }

Property Value​

TargetValueWriteModes

TargetValueKind​

public ValueKinds TargetValueKind { get; set; }

Property Value​

ValueKinds

DocumentMode​

public DocumentModes DocumentMode { get; set; }

Property Value​

DocumentModes

Description​

public string Description { get; set; }

Property Value​

String

Constructors​

SftpDownloadNodeConfiguration()​

Caution​

Constructors of types with required members are not supported in this version of your compiler.

public SftpDownloadNodeConfiguration()