Trigger

yaml
type: "io.kestra.plugin.fs.ftp.Trigger"

Examples

yaml
id: ftp_trigger_flow
namespace: company.team

tasks:
  - id: for_each_file
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.ftp.Trigger
    host: localhost
    port: 21
    username: foo
    password: "{{ secret('FTP_PASSWORD') }}"
    from: "/in/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive/"

yaml
id: ftp_trigger_flow
namespace: company.team

tasks:
  - id: for_each_file
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.name') }}"
      - id: delete
        type: io.kestra.plugin.fs.ftp.Delete
        host: localhost
        port: 21
        username: foo
        password: bar
        uri: "/in/{{ taskrun.value | jq('.name') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.ftp.Trigger
    host: localhost
    port: 21
    username: foo
    password: bar
    from: "/in/"
    interval: PT10S
    action: NONE

yaml
id: ftp_wait_for_csv_in_mydir
namespace: company.team

tasks:
  - id: each
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.ftp.Trigger
    host: localhost
    port: "21"
    username: foo
    password: bar
    from: "mydir/"
    regExp: ".*.csv"
    action: MOVE
    moveDirectory: "archive/"
    interval: PTS

Properties

action*string

Possible Values

MOVEDELETENONE

from*string

host*string

allowConcurrentboolean

Defaultfalse

conditions

Definitions

Condition to allow events between two specific datetime values.

type*object

afterstring

Formatdate-time

beforestring

Formatdate-time

datestring

Default{{ trigger.date }}

Condition to allow events on a particular day of the week.

dayOfWeek*string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type*object

datestring

Default{{ trigger.date }}

Condition to execute tasks on a specific day of the week relative to the current month (first, last, ...)

dayInMonth*string

Possible Values

FIRSTLASTSECONDTHIRDFOURTH

dayOfWeek*string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type*object

datestring

Default{{ trigger.date }}

Condition for a specific flow of an execution.

flowId*string

namespace*string

type*object

Condition that checks labels of an execution.

labels*arrayobject

type*object

Condition for an execution namespace.

namespace*string

type*object

comparisonstring

Possible Values

EQUALSPREFIXSUFFIX

prefixbooleanstring

Defaultfalse

Condition based on the outputs of an upstream execution.

expression*booleanstring

type*object

Condition based on execution status.

type*object

inarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

notInarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

Condition based on variable expression.

expression*string

type*object

Condition for a specific flow. Note that this condition is deprecated, use `io.kestra.plugin.core.condition.ExecutionFlow` instead.

flowId*string

namespace*string

type*object

Condition for a flow namespace.

namespace*string

type*object

prefixboolean

Defaultfalse

Condition that matches if any taskRun has retry attempts.

type*object

inarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

notInarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

Run a flow if the list of preconditions is met in a time window.

conditions*object

id*string

Validation RegExp^[a-zA-Z0-9][a-zA-Z0-9_-]*

Min length1

type*object

resetOnSuccessboolean

Defaulttrue

timeWindow

Default

{
  "type": "DURATION_WINDOW"
}

io.kestra.core.models.triggers.TimeWindow

deadlinestring

Formatpartial-time

endTimestring

Formatpartial-time

startTimestring

Formatpartial-time

typestring

DefaultDURATION_WINDOW

Possible Values

DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOW

windowstring

Formatduration

windowAdvancestring

Formatduration

windowstring

Formatduration

windowAdvancestring

Formatduration

Condition to exclude other conditions.

conditions*

Min items1

type*object

Condition to have at least one condition validated.

conditions*

Min items1

type*object

Condition to allow events on public holidays.

type*object

countrystring

datestring

Default{{ trigger.date}}

subDivisionstring

Condition to allow events between two specific times.

type*object

afterstring

Formattime

beforestring

Formattime

datestring

Default{{ trigger.date }}

Condition to allow events on weekend.

type*object

datestring

Default{{ trigger.date }}

enableSshRsa1booleanstring

Defaultfalse

intervalstring

DefaultPT1M

Formatduration

moveDirectorystring

onstring

DefaultCREATE_OR_UPDATE

Possible Values

CREATEUPDATECREATE_OR_UPDATE

options

Default

{
  "connectionTimeout": "PT30S",
  "dataTimeout": "PT30S",
  "socketTimeout": "PT30S",
  "controlKeepAliveTimeout": "PT30S",
  "controlKeepAliveReplyTimeout": "PT30S"
}

Definitions

io.kestra.plugin.fs.ftp.FtpInterface-Options

connectionTimeoutstring

DefaultPT30S

Formatduration

controlKeepAliveReplyTimeoutstring

DefaultPT30S

Formatduration

controlKeepAliveTimeoutstring

DefaultPT30S

Formatduration

dataTimeoutstring

DefaultPT30S

Formatduration

socketTimeoutstring

DefaultPT30S

Formatduration

passiveModebooleanstring

Defaulttrue

passwordstring

portstring

Default21

proxyHoststring

proxyPortstring

proxyTypestring

Possible Values

DIRECTHTTPSOCKS

recursivebooleanstring

Defaultfalse

regExpstring

remoteIpVerificationbooleanstring

Defaulttrue

rootDirbooleanstring

Defaulttrue

stateKeystring

stateTtlstring

Formatduration

stopAfterarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

usernamestring

Outputs

filesarray

Definitions

io.kestra.plugin.fs.vfs.Trigger-TriggeredFile

changeTypestring

Possible Values

CREATEUPDATE

accessDatestring

Formatdate-time

fileTypestring

Possible Values

FOLDERFILEFILE_OR_FOLDERIMAGINARY

flagsinteger

groupIdinteger

namestring

pathstring

Formaturi

permissionsinteger

sizeinteger

symbolicLinkboolean

Defaultfalse

updatedDatestring

Formatdate-time

userIdinteger

Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

CoreStorageScript

PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Database

SurrealDB

Tasks that run SurrealQL queries against SurrealDB.

Database

Trigger

More Plugins in this Category

Core Plugins and tasks

PostgreSQL

SurrealDB

1.2.1