Trigger
If you would like to consume each message from a NATS subject in real-time and create one execution per message, you can use the io.kestra.plugin.nats.RealtimeTrigger instead.

Trigger a flow on periodic message consumption from a NATS subject on a JetStream-enabled NATS server.

If you would like to consume each message from a NATS subject in real-time and create one execution per message, you can use the io.kestra.plugin.nats.RealtimeTrigger instead.

yaml
type: "io.kestra.plugin.nats.core.Trigger"

Examples

Subscribe to a NATS subject, getting every message from the beginning of the subject on first trigger execution.

yaml
id: nats
namespace: company.team

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

triggers:
  - id: watch
    type: io.kestra.plugin.nats.core.Trigger
    url: nats://localhost:4222
    username: nats_user
    password: nats_password
    subject: kestra.trigger
    durableId: natsTrigger
    deliverPolicy: All
    maxRecords: 1

Properties

subject*string

Min length1

Subject to subscribe to

url*string

Min length1

URL to connect to NATS server

The format is (nats://)server_url: port. You can also provide a connection token like so: nats://token@server_url: port

batchSizeinteger

Default10

Minimum>= 1

Messages are fetched by batch of given size.

conditions

List of conditions in order to limit the flow trigger.

Definitions

Condition to allow events between two specific datetime values.

type*object

afterstring

Formatdate-time

The date to test must be after this one.

beforestring

Formatdate-time

The date to test must be before this one.

Must be a valid ISO 8601 datetime with the zone identifier (use 'Z' for the default zone identifier).

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

Are you looking for the first or the last day in the month?

dayOfWeek*string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

The day of week.

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

List of labels to match in the execution.

type*object

Condition for an execution namespace.

namespace*string

String against which to match the execution namespace depending on the provided comparison.

type*object

comparisonstring

Possible Values

EQUALSPREFIXSUFFIX

Comparison to use when checking if namespace matches. If not provided, it will use EQUALS by default.

prefixbooleanstring

Defaultfalse

Whether to look at the flow namespace by prefix. Shortcut for comparison: PREFIX.

Only used when comparison is not set

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

The flow id.

namespace*string

The namespace of the flow.

type*object

Condition for a flow namespace.

namespace*string

The namespace of the flow or the prefix if prefix is true.

type*object

prefixboolean

Defaultfalse

If we must look at the flow namespace by prefix (checked using startsWith). The prefix is case sensitive.

Condition that matches if any taskRun has retry attempts.

type*object

inarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of states that are authorized.

notInarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of states that aren't authorized.

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

conditions*object

The list of preconditions to wait for

The key must be unique for a trigger because it will be used to store the previous evaluation result.

id*string

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

Min length1

A unique id for the condition

type*object

resetOnSuccessboolean

Defaulttrue

Whether to reset the evaluation results of SLA conditions after a first successful evaluation within the given time period.

By default, after a successful evaluation of the set of SLA conditions, the evaluation result is reset, so, the same set of conditions needs to be successfully evaluated again in the same time period to trigger a new execution. This means that to create multiple executions, the same set of conditions needs to be evaluated to true multiple times. You can disable this by setting this property to false so that, within the same period, each time one of the conditions is satisfied again after a successful evaluation, it will trigger a new execution.

timeWindow

Default

{
  "type": "DURATION_WINDOW"
}

Define the time period (or window) for evaluating preconditions.

You can set the type of sla to one of the following values:

DURATION_WINDOW: this is the default type. It uses a start time (windowAdvance) and end time (window) that are moving forward to the next interval whenever the evaluation time reaches the end time, based on the defined duration window. For example, with a 1-day window (the default option: window: PT1D), the SLA conditions are always evaluated during 24h starting at midnight (i.e. at time 00: 00: 00) each day. If you set windowAdvance: PT6H, the window will start at 6 AM each day. If you set windowAdvance: PT6H and you also override the window property to PT6H, the window will start at 6 AM and last for 6 hours — as a result, Kestra will check the SLA conditions during the following time periods: 06: 00 to 12: 00, 12: 00 to 18: 00, 18: 00 to 00: 00, and 00: 00 to 06: 00, and so on.
SLIDING_WINDOW: this option also evaluates SLA conditions over a fixed time window, but it always goes backward from the current time. For example, a sliding window of 1 hour (window: PT1H) will evaluate executions for the past hour (so between now and one hour before now). It uses a default window of 1 day.
DAILY_TIME_DEADLINE: this option declares that some SLA conditions should be met "before a specific time in a day". With the string property deadline, you can configure a daily cutoff for checking conditions. For example, deadline: "09: 00: 00" means that the defined SLA conditions should be met from midnight until 9 AM each day; otherwise, the flow will not be triggered.
DAILY_TIME_WINDOW: this option declares that some SLA conditions should be met "within a given time range in a day". For example, a window from startTime: "06: 00: 00" to endTime: "09: 00: 00" evaluates executions within that interval each day. This option is particularly useful for declarative definition of freshness conditions when building data pipelines. For example, if you only need one successful execution within a given time range to guarantee that some data has been successfully refreshed in order for you to proceed with the next steps of your pipeline, this option can be more useful than a strict DAG-based approach. Usually, each failure in your flow would block the entire pipeline, whereas with this option, you can proceed with the next steps of the pipeline as soon as the data is successfully refreshed at least once within the given time range.

io.kestra.core.models.triggers.TimeWindow

deadlinestring

Formatpartial-time

SLA daily deadline

Use it only for DAILY_TIME_DEADLINE SLA.

endTimestring

Formatpartial-time

SLA daily end time

startTimestring

Formatpartial-time

SLA daily start time

Use it only for DAILY_TIME_WINDOW SLA.

typestring

DefaultDURATION_WINDOW

Possible Values

DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOW

The type of the SLA

The default SLA is a sliding window (DURATION_WINDOW) with a window of 24 hours.

windowstring

Formatduration

Use it only for DURATION_WINDOW or SLIDING_WINDOW SLA. See ISO_8601 Durations for more information of available duration value. The start of the window is always based on midnight except if you set windowAdvance parameter. Eg if you have a 10 minutes (PT10M) window, the first window will be 00: 00 to 00: 10 and a new window will be started each 10 minutes

windowAdvancestring

Formatduration

Use it only for DURATION_WINDOW SLA. Allow to specify the start time of the window Eg: you want a window of 6 hours (window=PT6H), by default the check will be done between: 00: 00 and 06: 00, 06: 00 and 12: 00, 12: 00 and 18: 00, and 18: 00 and 00: 00. If you want to check the window between 03: 00 and 09: 00, 09: 00 and 15: 00, 15: 00 and 21: 00, and 21: 00 and 3: 00, you will have to shift the window of 3 hours by settings windowAdvance: PT3H

windowstring

Formatduration

The duration of the window

Deprecated, use timeWindow.window instead.

windowAdvancestring

Formatduration

The window advance duration

Deprecated, use timeWindow.windowAdvance instead.

Condition to exclude other conditions.

conditions*

Min items1

The list of conditions to exclude.

If any condition is true, it will prevent the event's execution.

type*object

Condition to have at least one condition validated.

conditions*

Min items1

The list of conditions to validate.

If any condition is true, it will allow the event's execution.

type*object

Condition to allow events on public holidays.

type*object

countrystring

ISO 3166-1 alpha-2 country code. If not set, it uses the country code from the default locale.

datestring

Default{{ trigger.date}}

subDivisionstring

ISO 3166-2 country subdivision (e.g., provinces and states) code.

It uses the Jollyday library for public holiday calendar that supports more than 70 countries.

Condition to allow events between two specific times.

type*object

afterstring

Formattime

The time to test must be after this one.

beforestring

Formattime

The time to test must be before this one.

Must be a valid ISO 8601 time with offset.

datestring

Default{{ trigger.date }}

The time to test.

Can be any variable or any valid ISO 8601 time. By default, it will use the trigger date.

Condition to allow events on weekend.

type*object

datestring

Default{{ trigger.date }}

The date to test.

Can be any variable or any valid ISO 8601 datetime. By default, it will use the trigger date.

credsstring

Credentials files authentification

deliverPolicystring

DefaultAll

Possible Values

AllLastNewByStartSequenceByStartTimeLastPerSubject

The point in the stream to receive messages from.

Possible settings are:

All: The default policy. The consumer will start receiving from the earliest available message.
Last: When first consuming messages, the consumer will start receiving messages with the last message added to the stream, or the last message in the stream that matches the consumer's filter subject if defined.
New: When first consuming messages, the consumer will only start receiving messages that were created after the consumer was created.
ByStartSequence: When first consuming messages, start at the first message having the sequence number or the next one available.
ByStartTime: When first consuming messages, start with messages on or after this time. The consumer is required to specify since which defines this start time.
LastPerSubject: When first consuming messages, start with the latest one for each filtered subject currently in the stream.

durableIdstring

ID used to attach the subscription to a durable one, allowing the subscription to start back from a previous position

intervalstring

DefaultPT1M

Formatduration

Interval between polling.

The interval between 2 different polls of schedule, this can avoid to overload the remote system with too many calls. For most of the triggers that depend on external systems, a minimal interval must be at least PT30S. See ISO_8601 Durations for more information of available interval values.

maxDurationstring

Formatduration

The max duration before stopping the message polling

It's not an hard limit and is evaluated every second

maxRecordsintegerstring

The max number of rows to fetch before stopping

passwordstring

Plaintext authentication password

pollDurationstring

DefaultPT2S

Formatduration

Polling duration before processing message

If no messages are available, define the max duration to wait for new messages

sincestring

Minimum message timestamp to start consumption from.

By default, we consume all messages from the subjects starting from beginning of logs or depending on the current durable id position. You can also provide an arbitrary start time to get all messages since this date for a new durable id. Note that if you don't provide a durable id, you will retrieve all messages starting from this date even after subsequent usage of this task.Must be a valid iso 8601 date.

stopAfterarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

tokenstring

Token authentification

usernamestring

Plaintext authentication username

Outputs

messagesCountinteger

Number of messages consumed.

uristring

Formaturi

URI of a Kestra internal storage file.

Resend

Plugin Resend for Kestra

Messaging

MQTT

This sub-group of plugins contains tasks for using a MQTT message broker.

Messaging

JMS

JMS messaging support plugins Trigger/Consumer/Producer

Messaging

Trigger
If you would like to consume each message from a NATS subject in real-time and create one execution per message, you can use the io.kestra.plugin.nats.RealtimeTrigger instead.

More Plugins in this Category

Resend

MQTT

JMS

1.1.1

​TriggerIf you would like to consume each message from a NATS subject in real-time and create one execution per message, you can use the io.kestra.plugin.nats.RealtimeTrigger instead.

More Plugins in this Category

Resend

MQTT

JMS

1.1.1

Trigger
If you would like to consume each message from a NATS subject in real-time and create one execution per message, you can use the io.kestra.plugin.nats.RealtimeTrigger instead.