<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeAMQP</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ConsumeAMQP</h1><h2>Description: </h2><p>Consumes AMQP Messages from an AMQP Broker using the AMQP 0.9.1 protocol. Each message that is received from the AMQP Broker will be emitted as its own FlowFile to the 'success' relationship.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>amqp, rabbit, get, message, receive, consume</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Queue</strong></td><td>Queue</td><td></td><td id="allowable-values"></td><td id="description">The name of the existing AMQP Queue from which messages will be consumed. Usually pre-defined by AMQP administrator. </td></tr><tr><td id="name"><strong>Auto-Acknowledge Messages</strong></td><td>auto.acknowledge</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description"> If false (Non-Auto-Acknowledge), the messages will be acknowledged by the processor after transferring the FlowFiles to success and committing the NiFi session. Non-Auto-Acknowledge mode provides 'at-least-once' delivery semantics. If true (Auto-Acknowledge), messages that are delivered to the AMQP Client will be auto-acknowledged by the AMQP Broker just after sending them out. This generally will provide better throughput but will also result in messages being lost upon restart/crash of the AMQP Broker, NiFi or the processor. Auto-Acknowledge mode provides 'at-most-once' delivery semantics and it is recommended only if loosing messages is acceptable.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td>batch.size</td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The maximum number of messages that should be processed in a single session. Once this many messages have been received (or once no more messages are readily available), the messages received will be transferred to the 'success' relationship and the messages will be acknowledged to the AMQP Broker. Setting this value to a larger number could result in better performance, particularly for very small messages, but can also result in more messages being duplicated upon sudden restart of NiFi.</td></tr><tr><td id="name">Remove Curly Braces</td><td>remove.curly.braces</td><td id="default-value">False</td><td id="allowable-values"><ul><li>True</li><li>False</li></ul></td><td id="description">If true Remove Curly Braces, Curly Braces in the header will be automatically remove.</td></tr><tr><td id="name">Header Separator</td><td>header.separator</td><td id="default-value">,</td><td id="allowable-values"></td><td id="description">The character that is used to separate key-value for header in String. The value must only one character.Otherwise you will get an error message</td></tr><tr><td id="name">Brokers</td><td>Brokers</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of known AMQP Brokers in the format &lt;host&gt;:&lt;port&gt; (e.g., localhost:5672). If this is set, Host Name and Port are ignored. Only include hosts from the same AMQP cluster.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Host Name</td><td>Host Name</td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of AMQP broker (e.g., localhost). If Brokers is set, then this property is ignored.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Port</td><td>Port</td><td id="default-value">5672</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of AMQP broker (e.g., 5671). If Brokers is set, then this property is ignored.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Virtual Host</td><td>Virtual Host</td><td></td><td id="allowable-values"></td><td id="description">Virtual Host name which segregates AMQP system for enhanced security.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">User Name</td><td>User Name</td><td></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Password</td><td>Password</td><td></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>AMQP Version</strong></td><td>AMQP Version</td><td id="default-value">0.9.1</td><td id="allowable-values"><ul><li>0.9.1</li></ul></td><td id="description">AMQP Version. Currently only supports AMQP v0.9.1.</td></tr><tr><td id="name">SSL Context Service</td><td>ssl-context-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Use Client Certificate Authentication</td><td>cert-authentication</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Authenticate using the SSL certificate rather than user name/password.</td></tr><tr><td id="name">Client Auth</td><td>ssl-client-auth</td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">The property has no effect and therefore deprecated.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received from the AMQP queue are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>amqp$appId</td><td>The App ID field from the AMQP Message</td></tr><tr><td>amqp$contentEncoding</td><td>The Content Encoding reported by the AMQP Message</td></tr><tr><td>amqp$contentType</td><td>The Content Type reported by the AMQP Message</td></tr><tr><td>amqp$headers</td><td>The headers present on the AMQP Message</td></tr><tr><td>amqp$deliveryMode</td><td>The numeric indicator for the Message's Delivery Mode</td></tr><tr><td>amqp$priority</td><td>The Message priority</td></tr><tr><td>amqp$correlationId</td><td>The Message's Correlation ID</td></tr><tr><td>amqp$replyTo</td><td>The value of the Message's Reply-To field</td></tr><tr><td>amqp$expiration</td><td>The Message Expiration</td></tr><tr><td>amqp$messageId</td><td>The unique ID of the Message</td></tr><tr><td>amqp$timestamp</td><td>The timestamp of the Message, as the number of milliseconds since epoch</td></tr><tr><td>amqp$type</td><td>The type of message</td></tr><tr><td>amqp$userId</td><td>The ID of the user</td></tr><tr><td>amqp$clusterId</td><td>The ID of the AMQP Cluster</td></tr><tr><td>amqp$routingKey</td><td>The routingKey of the AMQP Message</td></tr><tr><td>amqp$exchange</td><td>The exchange from which AMQP Message was received</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>