SFTPFilePair Class

Summary

this class contains a pair of file paths for both the local as the remote path for that file.
Assembly
Cake.SFTP.dll
Namespace
Cake.SFTP
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["SFTPFilePair"] class Type type-node

Syntax

public class SFTPFilePair

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Name Summary
SFTPFilePair() The constructor
SFTPFilePair(string, string) The constructor

Properties

Name Value Summary
LocalFilePath string
The local path of the file
RemoteFilePath string
The SFTP server path of the file

Extension Methods

Name Value Summary
Dump<SFTPFilePair>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SFTPFilePair>(SFTPFilePair[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SFTPFilePair>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<SFTPFilePair>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<SFTPFilePair>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<SFTPFilePair>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin