Trigger Trigger 

type: "io.kestra.plugin.mqtt.Trigger"

Wait for messages on MQTT topics

# Examples

id: "trigger"
type: "io.kestra.plugin.mqtt.Trigger"
server: tcp://localhost:1883
clientId: kestraProducer
topic: 
 - kestra/sensors/cpu
 - kestra/sensors/mem
serdeType: JSON
maxRecords: 10

# Properties

# authMethod

  • Type: string
  • Dynamic: ❓
  • Required: ❌

# clientId

  • Type: string
  • Dynamic: ❓
  • Required: ❌

# connectionTimeout

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Format: duration

# httpsHostnameVerificationEnabled

  • Type: boolean
  • Dynamic: ❓
  • Required: ❌

# interval

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: PT1S
  • Format: duration

Interval between polling

The interval between 2 different test of schedule, this can avoid to overload the remote system with too many call. For most of trigger that depend on external system, a minimal interval must be at least PT30S.
See ISO_8601 Durations (opens new window) for more information of available interval value

# maxDuration

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Format: duration

The max duration waiting for new rows

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

# maxRecords

  • Type: integer
  • Dynamic: ❌
  • Required: ❌

The max number of rows to fetch before stopping

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

# password

  • Type: string
  • Dynamic: ❓
  • Required: ❌

# qos

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 1

Sets the quality of service for this message.

  • Quality of Service 0: indicates that a message should be delivered at most once (zero or one times). The message will not be persisted to disk, and will not be acknowledged across the network. This QoS is the fastest, but should only be used for messages which are not valuable - note that if the server cannot process the message (for example, there is an authorization problem). Also known as "fire and forget".
  • Quality of Service 1: indicates that a message should be delivered at least once (one or more times). The message can only be delivered safely if it can be persisted, so the application must supply a means of persistence using MqttConnectOptions. If a persistence mechanism is not specified, the message will not be delivered in the event of a client failure. The message will be acknowledged across the network.
  • Quality of Service 2: indicates that a message should be delivered once. The message will be persisted to disk, and will be subject to a two-phase acknowledgement across the network. The message can only be delivered safely if it can be persisted, so the application must supply a means of persistence using MqttConnectOptions. If a persistence mechanism is not specified, the message will not be delivered in the event of a client failure.
    If persistence is not configured, QoS 1 and 2 messages will still be delivered in the event of a network or server problem as the client will hold state in memory. If the MQTT client is shutdown or fails and persistence is not configured then delivery of QoS 1 and 2 messages can not be maintained as client-side state will be lost.

# serdeType

  • Type: string

  • Dynamic: ❌

  • Required: ❌

  • Default: JSON

  • Possible Values:

    • STRING
    • JSON
    • BYTES

Serializer / Deserializer used for the payload

# server

  • Type: string
  • Dynamic: ❓
  • Required: ❌

# topic

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

Topic where to consume message

Can be a string or a List of string to consume from multiple topic

# username

  • Type: string
  • Dynamic: ❓
  • Required: ❌

# version

  • Type: string

  • Dynamic: ❓

  • Required: ✔️

  • Default: V5

  • Possible Values:

    • V3
    • V5

# Outputs

# messagesCount

  • Type: integer

Number of message produced

# uri

  • Type: string

URI of a kestra internal storage file

← Batch →

 Tweet  Share  Share