remote

Documentation

Index

• Variables
• func WithCleanup() heartbeat.HandleOption
• func WithDetection() heartbeat.HandleOption
• type Client
  • func NewClient(address string) (Client, error)
  • func (c Client) Connect() (*ssh.Client, *sftp.Client, error)
  • func (c Client) DownloadFile(localFile string) error

Variables

var RemoteAddressRegex = regexp.MustCompile(`(?i)^((ssh|sftp)://)+(?P<credentials>[^:@]+(:([^:@])+)?@)?[^:]+(:\d+)?`)

RemoteAddressRegex is a pattern for (ssh|sftp)://user:pass@host:port.

Functions

func WithCleanup

func WithCleanup() heartbeat.HandleOption

WithCleanup initializes and returns a heartbeat handle option, which deletes a local temporary file if downloaded from a remote file.

func WithDetection

func WithDetection() heartbeat.HandleOption

WithDetection initializes and returns a heartbeat handle option, which can be used in a heartbeat processing pipeline to detect remote file and download to a temporary directory.

Types

type Client

type Client struct {
	User         string
	Pass         string
	HostKeyAlias string
	OriginalHost string
	Host         string
	Port         int
	Path         string
}

Client communicates using sftp protocol.

func NewClient

func NewClient(address string) (Client, error)

NewClient initializes a new remote client.

func (Client) Connect

func (c Client) Connect() (*ssh.Client, *sftp.Client, error)

Connect connects to sftp host.

func (Client) DownloadFile

func (c Client) DownloadFile(localFile string) error

DownloadFile downloads a remote file and copy to a local file.