Trigger
yaml
type: "io.kestra.plugin.fs.smb.trigger"Examples
yaml
id: smb_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.smb.Trigger
host: localhost
port: "445"
username: foo
password: bar
from: "/my_share/in/"
interval: PT10S
action: MOVE
moveDirectory: "/archive_share/"
yaml
id: smb_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') }}"
- id: delete
type: io.kestra.plugin.fs.smb.Delete
host: localhost
port: "445"
username: foo
password: "{{ secret('SMB_PASSWORD') }}"
uri: "/my_share/in/{{ taskrun.value | jq('.path') }}"
triggers:
- id: watch
type: io.kestra.plugin.fs.smb.Trigger
host: localhost
port: "445"
username: foo
password: "{{ secret('SMB_PASSWORD') }}"
from: "/my_share/in/"
interval: PT10S
action: NONE
yaml
id: smb_wait_for_csv_in_my_share_my_dir
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.smb.Trigger
host: localhost
port: "445"
username: foo
password: "{{ secret('SMB_PASSWORD') }}"
from: "my_share/mydir/"
regExp: ".*.csv"
action: MOVE
moveDirectory: "my_share/archivedir"
interval: PTS
Properties
action *Requiredstring
Possible Values
MOVEDELETENONEfrom *Requiredstring
host *Requiredstring
conditions Non-dynamicDateTimeBetweenDayWeekDayWeekInMonthExecutionFlowExecutionLabelsExecutionNamespaceExecutionOutputsExecutionStatusExpressionFlowConditionFlowNamespaceConditionHasRetryAttemptMultipleConditionNotOrPublicHolidayTimeBetweenWeekend
enableSshRsa1 booleanstring
Default
falseinterval Non-dynamicstring
Default
PT1M Format
durationmoveDirectory string
password string
port string
Default
445recursive booleanstring
Default
falseregExp string
stopAfter Non-dynamicarray
SubType string
Possible Values
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTusername string
Definitions
io.kestra.core.models.triggers.TimeWindow
deadline string
Format
partial-timeendTime string
Format
partial-timestartTime string
Format
partial-timetype string
Default
DURATION_WINDOW Possible Values
DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOWwindow string
Format
durationwindowAdvance string
Format
durationCondition for a specific flow of an execution.
flowId *Requiredstring
namespace *Requiredstring
type *Requiredobject
Condition for a flow namespace.
namespace *Requiredstring
type *Requiredobject
prefix boolean
Default
falseio.kestra.plugin.fs.vfs.models.File
accessDate string
Format
date-timefileType string
Possible Values
FOLDERFILEFILE_OR_FOLDERIMAGINARYflags integer
groupId integer
name string
path string
Format
uripermissions integer
size integer
symbolicLink boolean
Default
falseupdatedDate string
Format
date-timeuserId integer
Condition for a specific flow. Note that this condition is deprecated, use `io.kestra.plugin.core.condition.ExecutionFlow` instead.
flowId *Requiredstring
namespace *Requiredstring
type *Requiredobject
Condition to allow events between two specific times.
type *Requiredobject
after string
Format
timebefore string
Format
timedate string
Default
{{ trigger.date }}Condition that checks labels of an execution.
labels *Requiredarrayobject
type *Requiredobject
Condition based on the outputs of an upstream execution.
expression *Requiredbooleanstring
type *Requiredobject
Condition to allow events on weekend.
type *Requiredobject
date string
Default
{{ trigger.date }}Condition to have at least one condition validated.
Condition for an execution namespace.
namespace *Requiredstring
type *Requiredobject
comparison string
Possible Values
EQUALSPREFIXSUFFIXprefix booleanstring
Default
falseRun a flow if the list of preconditions is met in a time window.
id *Requiredstring
Validation RegExp
^[a-zA-Z0-9][a-zA-Z0-9_-]* Min length
1type *Requiredobject
resetOnSuccess boolean
Default
truetimeWindow TimeWindow
Default
{
"type": "DURATION_WINDOW"
}Condition to exclude other conditions.
Condition to execute tasks on a specific day of the week relative to the current month (first, last, ...)
dayInMonth *Requiredstring
Possible Values
FIRSTLASTSECONDTHIRDFOURTHdayOfWeek *Requiredstring
Possible Values
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYtype *Requiredobject
date string
Default
{{ trigger.date }}Condition based on variable expression.
expression *Requiredstring
type *Requiredobject
Condition to allow events on a particular day of the week.
dayOfWeek *Requiredstring
Possible Values
MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAYtype *Requiredobject
date string
Default
{{ trigger.date }}Condition based on execution status.
type *Requiredobject
in array
SubType string
Possible Values
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTnotIn array
SubType string
Possible Values
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTCondition to allow events between two specific datetime values.
type *Requiredobject
after string
Format
date-timebefore string
Format
date-timedate string
Default
{{ trigger.date }}Condition that matches if any taskRun has retry attempts.
type *Requiredobject
in array
SubType string
Possible Values
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTnotIn array
SubType string
Possible Values
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTCondition to allow events on public holidays.
type *Requiredobject
country string
date string
Default
{{ trigger.date }}