Trigger

yaml
type: "io.kestra.plugin.kafka.trigger"

Examples

yaml
id: kafka_trigger
namespace: company.team

tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: "{{ trigger.value }}"

triggers:
  - id: trigger
    type: io.kestra.plugin.kafka.Trigger
    topic: test_kestra
    properties:
      bootstrap.servers: localhost:9092
    serdeProperties:
      schema.registry.url: http://localhost:8085
      keyDeserializer: STRING
      valueDeserializer: AVRO
    interval: PT30S
    maxRecords: 5
    groupId: kafkaConsumerGroupId

Properties

groupId *string

properties *object

SubType string

conditions DateTimeBetween DayWeek DayWeekInMonth ExecutionFlow ExecutionLabels ExecutionNamespace ExecutionOutputs ExecutionStatus Expression FlowCondition FlowNamespaceCondition HasRetryAttempt MultipleCondition Not Or PublicHoliday TimeBetween Weekend

interval string

Default PT1M

Format duration

keyDeserializer string

Default STRING

Possible Values

STRINGINTEGERFLOATDOUBLELONGSHORTBYTE_ARRAYBYTE_BUFFERBYTESUUIDVOIDAVROJSON

maxDuration string

Format duration

maxRecords integerstring

onSerdeError KafkaConsumerInterface-OnSerdeError

partitions array

SubType integer

pollDuration string

Default PT5S

Format duration

serdeProperties object

SubType string

Default {}

since string

stopAfter array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

topic object

topicPattern string

valueDeserializer string

Default STRING

Possible Values

STRINGINTEGERFLOATDOUBLELONGSHORTBYTE_ARRAYBYTE_BUFFERBYTESUUIDVOIDAVROJSON

Outputs

messagesCount integer

uri string

Format uri

Definitions

io.kestra.core.models.triggers.TimeWindow

deadline string

Format partial-time

endTime string

Format partial-time

startTime string

Format partial-time

type string

Default DURATION_WINDOW

Possible Values

DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOW

window string

Format duration

windowAdvance string

Format duration

Condition for a specific flow of an execution.

flowId *string

namespace *string

type *object

Condition for a flow namespace.

namespace *string

type *object

prefix boolean

Default false

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 to allow events between two specific times.

type *object

after string

Format time

before string

Format time

date string

Default {{ trigger.date }}

Condition that checks labels of an execution.

labels *arrayobject

type *object

Condition based on the outputs of an upstream execution.

expression *booleanstring

type *object

Condition to allow events on weekend.

type *object

date string

Default {{ trigger.date }}

io.kestra.plugin.kafka.KafkaConsumerInterface-OnSerdeError

topic string

type string

Default SKIPPED

Possible Values

SKIPPEDDLQSTORE

Condition to have at least one condition validated.

conditions *DateTimeBetween DayWeek DayWeekInMonth ExecutionFlow ExecutionLabels ExecutionNamespace ExecutionOutputs ExecutionStatus Expression FlowCondition FlowNamespaceCondition HasRetryAttempt MultipleCondition Not Or PublicHoliday TimeBetween Weekend

Min items 1

type *object

Condition for an execution namespace.

namespace *string

type *object

comparison string

Possible Values

EQUALSPREFIXSUFFIX

prefix booleanstring

Default false

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

conditions *object

SubType

id *string

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

Min length 1

type *object

resetOnSuccess boolean

Default true

timeWindow TimeWindow

Default

{
  "type": "DURATION_WINDOW"
}

Condition to exclude other conditions.

Min items 1

type *object

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

date string

Default {{ trigger.date }}

Condition based on variable expression.

expression *string

type *object

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

dayOfWeek *string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type *object

date string

Default {{ trigger.date }}

Condition based on execution status.

type *object

in array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

notIn array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

Condition to allow events between two specific datetime values.

type *object

after string

Format date-time

before string

Format date-time

date string

Default {{ trigger.date }}

Condition that matches if any taskRun has retry attempts.

type *object

in array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

notIn array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

Condition to allow events on public holidays.

type *object

country string

date string

Default {{ trigger.date }}

subDivision string

​Trigger

Trigger