Consume Consume

yaml
type: "io.kestra.plugin.solace.Consume"

Consume messages from a Solace broker.

Examples

Consume messages from a Solace queue.

yaml
id: consume_message_from_solace_queue
namespace: company.team

tasks:
  - id: consume_from_solace
    type: io.kestra.plugin.solace.Consume
    host: localhost:55555
    username: admin
    password: admin
    vpn: default
    messageDeserializer: JSON
    queueName: test_queue
    queueType: DURABLE_EXCLUSIVE

Properties

host

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The Solace hostname to connect with.

messageDeserializer

  • Type: string
  • Dynamic:
  • Required: ✔️
  • Default: STRING
  • Possible Values:
    • STRING
    • BINARY
    • ION
    • JSON

The Deserializer to be used for deserializing messages.

queueName

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The name of the solace queue to consume from.

queueType

  • Type: string
  • Dynamic:
  • Required: ✔️
  • Possible Values:
    • DURABLE_EXCLUSIVE
    • DURABLE_NON_EXCLUSIVE
    • NON_DURABLE_EXCLUSIVE

The type of the queue to be consumed.

vpn

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: default

The Solace VPN to connect with.

maxDuration

  • Type: string
  • Dynamic:
  • Required:
  • Default: 10.000000000
  • Format: duration

The maximum time to wait for receiving a number of messages up to maxMessages.

maxMessages

  • Type: integer
  • Dynamic:
  • Required:
  • Default: 100

The maximum number of messages to be received per poll.

messageDeserializerProperties

  • Type: object
  • Dynamic:
  • Required:
  • Default: {}

The config properties to be passed to the Deserializer.

Configs in key/value pairs.

messageSelector

  • Type: string
  • Dynamic:
  • Required:

The message selector to be used for receiving messages.

Enables support for message selection based on message header parameter and message properties values.

password

  • Type: string
  • Dynamic: ✔️
  • Required:

The Solace password.

properties

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required:
  • Default: {}

The Solace properties to be used for connecting to the broker.

username

  • Type: string
  • Dynamic: ✔️
  • Required:

The Solace username.

Outputs

messagesCount

  • Type: integer
  • Required:

Number of messages consumed from the Solace broker.

uri

  • Type: string
  • Required:
  • Format: uri

URI of a Kestra's internal storage file containing the messages.

Definitions

Was this page helpful?