RealtimeTrigger
This trigger listens to a JMS queue or topic and starts a new flow for each message.

Trigger a flow execution on a JMS message.

This trigger listens to a JMS queue or topic and starts a new flow for each message.

yaml
type: "io.kestra.plugin.jms.RealtimeTrigger"

Examples

Start a flow for each message on a specific JMS queue.

yaml
id: jms-realtime-flow
namespace: at.conapi.dev

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

triggers:
  - id: jms-trigger
    type: io.kestra.plugin.jms.RealtimeTrigger
    connectionFactoryConfig:
      type: DIRECT
      providerJarPaths: kestra:///jms/activemq-client.jar
      connectionFactoryClass: org.apache.activemq.ActiveMQConnectionFactory
    destination:
      name: "kestra.events"
      destinationType: QUEUE

Properties

connectionFactoryConfig*

Definitions

io.kestra.plugin.jms.configuration.ConnectionFactoryConfig-Direct

connectionFactoryClass*string

Connection Factory Class

The fully qualified class name of the JMS ConnectionFactory.

connectionPropertiesobject

passwordstring

providerJarPathsarray

SubTypestring

useFilteredClassLoaderbooleanstring

Defaultfalse

usernamestring

io.kestra.plugin.jms.configuration.ConnectionFactoryConfig-Jndi

jndiConnectionFactoryName*string

JNDI Connection Factory Name

jndiInitialContextFactory*string

JNDI Initial Context Factory

jndiProviderUrl*string

JNDI Provider URL

connectionPropertiesobject

Connection Properties

Additional (Pojo) properties to set on the Direct/JNDI ConnectionFactory instance.

jndiCredentialsstring

JNDI Credentials

jndiPrincipalstring

JNDI Principal

passwordstring

The password for broker authentication.

providerJarPathsarray

SubTypestring

Provider JAR Path(s)

The path to the JMS provider's JAR file(s). This can be a single path or a list of paths (JARs). (e.g., 'file:///app/plugins/jms-libs/client.jar').If not specified, all jar files in the 'jms-libs' sub folder of your plugins location will be added to the classpath.

useFilteredClassLoaderbooleanstring

Defaultfalse

Use Filtered ClassLoader

Enable this for JMS providers that bundle JMS API classes in their JAR (e.g., SonicMQ/Aurea Messenger). When enabled, JMS API classes are loaded from the parent classloader to prevent ClassCastException. Leave disabled (default: false) for well-behaved providers like RabbitMQ, ActiveMQ, Artemis, etc. Only enable this if you encounter ClassCastException with javax.jms or jakarta.jms classes.

usernamestring

The username for broker authentication.

This is used when creating the connection to the JMS broker. Omit for JNDI if credentials are embedded in the ConnectionFactory.

destination*

The destination to consume messages from.

Definitions

io.kestra.plugin.jms.JMSDestination

destinationName*string

The name of the JMS queue or topic.

destinationTypestring

DefaultQUEUE

Possible Values

QUEUETOPIC

The type of the destination.

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.

messageSelectorstring

Message selector to only consume specific messages.

A JMS message selector expression to filter messages. Uses SQL-92 syntax (e.g., "JMSPriority > 5 AND type = 'order'").

serdeTypestring

DefaultSTRING

Possible Values

STRINGJSONBYTES

The format for deserializing the message body.

stopAfterarray

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

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

Outputs

contentEncodingstring

The message's content encoding.

contentTypestring

The message's content type.

correlationIdstring

The JMS Correlation ID.

dataobject

The deserialized message body.

deliveryModeinteger

The JMS delivery mode (1 for non-persistent, 2 for persistent).

expirationstring

Formatduration

The duration until the message expires.

headersobject

A map of message headers (JMS properties).

messageIdstring

The unique JMS Message ID.

priorityinteger

The message priority level.

replyTostring

The name of the destination to which a reply should be sent.

replyToTypestring

Possible Values

QUEUETOPIC

The type of the replyTo destination (QUEUE or TOPIC).

timestampstring

Formatdate-time

The timestamp when the message was sent.

Resend

Plugin Resend for Kestra

Messaging

MQTT

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

Messaging

Solace

This sub-group of plugins contains tasks for using the Solace broker.

Messaging

RealtimeTrigger
This trigger listens to a JMS queue or topic and starts a new flow for each message.

More Plugins in this Category

Resend

MQTT

Solace

1.1.1

​Realtime​TriggerThis trigger listens to a JMS queue or topic and starts a new flow for each message.

More Plugins in this Category

Resend

MQTT

Solace

1.1.1

RealtimeTrigger
This trigger listens to a JMS queue or topic and starts a new flow for each message.