Trigger
yaml
type: "io.kestra.plugin.fs.sftp.Trigger"
Wait for files on a SFTP server
Examples
Wait for a list of file on a SFTP server and iterate through the files
yaml
id: gcs-listen
namespace: io.kestra.tests
tasks:
- id: each
type: io.kestra.core.tasks.flows.EachSequential
tasks:
- id: return
type: io.kestra.core.tasks.debugs.Return
format: "{{taskrun.value}}"
value: "{{ trigger.files | jq('.path') }}"
triggers:
- id: watch
type: io.kestra.plugin.fs.sftp.Trigger
host: localhost
port: 6622
username: foo
password: pass
from: "/in/"
interval: PT10S
action: MOVE
moveDirectory: "/archive/"
Properties
action
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Possible Values:
MOVE
DELETE
The action to do on find files
from
- Type: string
- Dynamic: ✔️
- Required: ✔️
The directory to list
host
- Type: string
- Dynamic: ✔️
- Required: ✔️
Hostname of the remote server
interval
- Type: string
- Dynamic: ❌
- Required: ❌
- Format:
duration
The interval between test of triggers
keyfile
- Type: string
- Dynamic: ✔️
- Required: ❌
Private keyfile to login on the source server with ssh
moveDirectory
- Type: string
- Dynamic: ✔️
- Required: ❌
The destination directory in case off
MOVE
passphrase
- Type: string
- Dynamic: ✔️
- Required: ❌
Passphrase of the ssh key
password
- Type: string
- Dynamic: ✔️
- Required: ❌
Password on the remote server
port
- Type: string
- Dynamic: ✔️
- Required: ❌
- Default:
22
Port of the remote server
proxyHost
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy host
proxyPassword
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy password
proxyPort
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy port
proxyType
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy type
proxyUser
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy user
regExp
- Type: string
- Dynamic: ✔️
- Required: ❌
A regexp to filter on full path
rootDir
- Type: boolean
- Dynamic: ✔️
- Required: ❌
- Default:
true
Is path is relative to root dir
username
- Type: string
- Dynamic: ✔️
- Required: ❌
Username on the remote server
Outputs
files
The bucket of the downloaded file
Definitions
File
accessDate
- Type: string
- Dynamic: ❓
- Required: ❌
fileType
- Type: string
- Dynamic: ❓
- Required: ❌
- Possible Values:
FOLDER
FILE
FILE_OR_FOLDER
IMAGINARY
flags
- Type: integer
- Dynamic: ❓
- Required: ❌
groupId
- Type: integer
- Dynamic: ❓
- Required: ❌
name
- Type: string
- Dynamic: ❓
- Required: ❌
path
- Type: string
- Dynamic: ❓
- Required: ❌
permissions
- Type: integer
- Dynamic: ❓
- Required: ❌
size
- Type: integer
- Dynamic: ❓
- Required: ❌
symbolicLink
- Type: boolean
- Dynamic: ❓
- Required: ❌
- Default:
false
updatedDate
- Type: string
- Dynamic: ❓
- Required: ❌
userId
- Type: integer
- Dynamic: ❓
- Required: ❌