Trigger
yaml
type: "io.kestra.plugin.azure.eventhubs.trigger"Examples
yaml
id: azure_eventhubs_trigger
namespace: company.team
tasks:
- id: log
type: io.kestra.plugin.core.log.Log
message: Hello there! I received {{ trigger.eventsCount }} from Azure EventHubs!
triggers:
- id: read_from_eventhub
type: io.kestra.plugin.azure.eventhubs.Trigger
interval: PT30S
eventHubName: my_eventhub
namespace: my_eventhub_namespace
connectionString: "{{ secret('EVENTHUBS_CONNECTION') }}"
bodyDeserializer: JSON
consumerGroup: "$Default"
checkpointStoreProperties:
containerName: kestra
connectionString: "{{ secret('BLOB_CONNECTION') }}"
Properties
checkpointStoreProperties *Requiredobject
SubType string
eventHubName *Requiredstring
namespace *Requiredstring
bodyDeserializer string
Default
STRING Possible Values
STRINGBINARYIONJSONbodyDeserializerProperties object
Default
{}clientMaxRetries integerstring
Default
5clientRetryDelay integerstring
Default
500conditions Non-dynamicDateTimeBetweenDayWeekDayWeekInMonthExecutionFlowExecutionLabelsExecutionNamespaceExecutionOutputsExecutionStatusExpressionFlowConditionFlowNamespaceConditionHasRetryAttemptMultipleConditionNotOrPublicHolidayTimeBetweenWeekend
connectionString string
consumerGroup string
Default
$DefaultcustomEndpointAddress string
enqueueTime string
interval Non-dynamicstring
Default
PT1M Format
durationmaxBatchSizePerPartition integerstring
Default
50maxDuration string
Default
PT10S Format
durationmaxWaitTimePerPartition string
Default
PT5S Format
durationpartitionStartingPosition string
Default
EARLIEST Possible Values
EARLIESTLATESTINSTANTsasToken string
stopAfter Non-dynamicarray
SubType string
Possible Values
CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTOutputs
eventsCount integer
uri string
Format
uriDefinitions
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
falseCondition 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 }}