amqp (AMQP)

An AMQP triggerer reaches out to an AMQP queue (e.g. RabbitMQ) and picks up messages from it as though it was a dbQueue or memQueue.

The queue, username, password, host, and port are mandatory fields.

class names

scala: code.model.flows.processors.amqp.AmqpTriggererFactory
javascript: code_model_flows_processors_amqp_AmqpTriggererFactory

aliases

rabbitMQ rabbitMQTrigger code.model.flows.processors.amqp.AmqpTriggererConfig

end type

config

{"categories":[{"defaultCollapsed":false,"fields":["queue","encoding","implicitAck","maxMatchSize","consumerTag"],"name":"AMQP"},{"defaultCollapsed":true,"fields":["streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics"],"name":"Advanced Run Configuration"}],"fieldName":"amqp","fields":[{"default":[],"fieldName":"amqp.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"amqp.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"amqp.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"amqp","fieldName":"amqp.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"amqp.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"amqp.mutualReentrancyKey","hidden":false,"hideLabel":false,"name":"mutualReentrancyKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"categories":[{"defaultCollapsed":false,"fields":["host","port"],"name":"Server"},{"defaultCollapsed":false,"fields":["username","password"],"name":"Credentials"}],"fieldName":"amqp.provider","fields":[{"default":null,"fieldName":"amqp.provider.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"code.model.flows.processors.amqp.AmqpConfiguration","fieldName":"amqp.provider.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"amqp.provider.username","hidden":false,"hideLabel":false,"label":"Username","name":"username","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"Hostname of the AMQP server.","default":null,"fieldName":"amqp.provider.host","hidden":false,"hideLabel":false,"label":"Hostname","name":"host","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"T1726099537075_F99803548078IUSM4I","fieldName":"amqp.provider.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"Default AMQP port is 5672.","default":5672,"fieldName":"amqp.provider.port","hidden":false,"hideLabel":false,"label":"Port","name":"port","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"amqp.provider.password","hidden":false,"hideLabel":false,"label":"Password","name":"password","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Provider","name":"provider","readonly":false,"renderStrategies":[],"type":"O"},{"default":"collecting","fieldName":"amqp.streamType","hidden":false,"hideLabel":false,"name":"streamType","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["collecting","eager","forgetful"],"displayOverride":{},"rule":"choices","unenforced":false}]},{"default":false,"fieldName":"amqp.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":[],"fieldName":"amqp.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"amqp.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"bindingHint":"Name of the AMQP queue.","default":null,"fieldName":"amqp.queue","hidden":false,"hideLabel":false,"label":"Queue","name":"queue","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"","fieldName":"amqp.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":false,"fieldName":"amqp.nonReentrant","hidden":false,"hideLabel":false,"name":"nonReentrant","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"bindingHint":"The encoding of the messages in the queue.","default":"UTF-8","fieldName":"amqp.encoding","hidden":false,"hideLabel":false,"label":"Encoding","name":"encoding","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"amqp.orchestratorName","hidden":false,"hideLabel":false,"name":"orchestratorName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"T1726099537075_F99803548126RHH1JR","fieldName":"amqp.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"Max number of messages to process at a time.","default":1,"fieldName":"amqp.maxBatchSize","hidden":false,"hideLabel":false,"label":"Max Batch Size","name":"maxBatchSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":[],"fieldName":"amqp.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"amqp.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"amqp.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"amqp.killOnStop","hidden":false,"hideLabel":false,"name":"killOnStop","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"canReference":false,"default":180000,"fieldName":"amqp.orchestrationTimeout","hidden":false,"hideLabel":false,"label":"Orchestration Timeout","name":"orchestrationTimeout","readonly":false,"renderStrategies":[{"config":{"precision":3,"timeUnit":"ms"},"type":"valueAsTimeSpan"}],"type":"L","validators":[]},{"default":"statefulBehaviour","fieldName":"amqp.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"Whether to automatically ack each message after processing.","default":true,"fieldName":"amqp.implicitAck","hidden":false,"hideLabel":false,"label":"Implicit Ack","name":"implicitAck","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"amqp.env","hidden":false,"hideLabel":false,"name":"env","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"Unique identifier for the AMQP consumer.","default":"flow-F99803548087FS05BL","fieldName":"amqp.consumerTag","hidden":false,"hideLabel":false,"label":"Consumer Tag","name":"consumerTag","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Triggerer Configuration","name":"amqp","readonly":false,"renderStrategies":[],"type":"O"}