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":["useVirtualThreads","poolSize","sharedPoolName","streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics","startupPriority","shouldPinFlows"],"name":"Advanced Run Configuration"}],"fieldName":"amqp","fields":[{"default":null,"fieldName":"amqp.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"amqp.runOnlyOnRanks.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":"${generatedId}","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":null,"fieldName":"amqp.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"amqp.runOnlyOnRoles.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":[]},{"bindingHint":"the size of the threadpool. If this is set to a positive number, this trigger will use a dedicated threadpool. If this is set to zero or less, it will use the default shared threadpool.","canReference":true,"default":null,"fieldName":"amqp.poolSize","hidden":false,"hideLabel":false,"label":"threadpool size","name":"poolSize","readonly":false,"renderStrategies":[],"type":"I","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":[]},{"bindingHint":"If this trigger is set to use a dedicated threadpool (using the poolSize attribute), then this name will override which threadpool this trigger uses. By default, triggers using dedicated threadpools will use a threadpool each, but if you set multiple triggers with the same name and pool size, they will share that pool.","canReference":true,"default":null,"fieldName":"amqp.sharedPoolName","hidden":false,"hideLabel":false,"label":"shared threadpool","name":"sharedPoolName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"Allow Stateful Behaviours to opt out of pinning dependent Flows into memory. By default Flows pinned to memory when referenced by a Stateful Behaviour. This option allows one to override the default behaviour.","default":true,"fieldName":"amqp.shouldPinFlows","hidden":false,"hideLabel":false,"name":"shouldPinFlows","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":"${generatedId}","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":[]},{"bindingHint":"This is the order of startup when multiple stateful behaviours are being started at the same time. This is usually when a recipe is being run, or a bundle is being loaded, but is especially relevant when the server is being started.","default":1400,"fieldName":"amqp.startupPriority","hidden":false,"hideLabel":false,"name":"startupPriority","readonly":false,"renderStrategies":[],"type":"I","validators":[{"max":2048.0,"min":950.0,"rule":"numberRange"}]},{"default":null,"fieldName":"amqp.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"amqp.runOnlyOnHosts.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":[]},{"bindingHint":"If enabled, this trigger will use virtual threads. This confers a substantial performance benefit. When using virtual threads, all threadpool settings are ignored, and one virtual thread per task is automatically created. This is vastly more efficient and performant, with usually significantly lower latency, so this setting should only ever be switched off in very rare circumstances.","canReference":true,"default":true,"fieldName":"amqp.useVirtualThreads","hidden":false,"hideLabel":false,"label":"enableVirtualThreads","name":"useVirtualThreads","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":"${generatedId}","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"}