Consume
Consume messages from an AMQP queue.
Consume messages from an AMQP queue.
Consume messages from an AMQP queue.
Requires maxDuration or maxRecords.
type: "io.kestra.plugin.amqp.Consume"Examples
id: amqp_consume
namespace: company.team
tasks:
- id: consume
type: io.kestra.plugin.amqp.Consume
host: localhost
port: 5672
username: guest
password: guest
virtualHost: /my_vhost
queue: kestramqp.queue
maxRecords: 1000
Properties
host*Requiredstring
The broker host
queue*Requiredstring
The queue to pull messages from
serdeType*Requiredstring
STRINGSTRINGJSONSerialization format
Defines how message payloads are serialized or deserialized. Use STRING for plain text or JSON for structured data.
consumerTagstring
KestraA client-generated consumer tag to establish context
maxDurationstring
durationMaximum duration
The maximum duration the consumer will run before stopping. This is a soft limit evaluated approximately every 100 milliseconds, so the actual duration may slightly exceed this value.
maxRecordsintegerstring
Maximum number of records
The maximum number of messages to consume before stopping. This is a soft limit evaluated after each message.
passwordstring
The broker password
portstring
5672The broker port
usernamestring
The broker username
virtualHoststring
/The broker virtual host
Outputs
countinteger
Number of rows consumed
uristring
uriFile URI containing consumed messages
Metrics
consumed.recordscounter
The total number of records consumed from the AMQP queue.
