org.apache.nifinifi-amqp-nar2.4.0org.apache.nifinifi-standard-services-api-nar2.4.02.1.0rel/nifi-2.4.0main1org.apache.nifi.amqp.processors.ConsumeAMQPPROCESSORConsumes 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.amqprabbitgetmessagereceiveconsumeQueueQueueThe name of the existing AMQP Queue from which messages will be consumed. Usually pre-defined by AMQP administrator. truefalsefalseNONEfalsefalseauto.acknowledgeAuto-Acknowledge Messages 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.falsetruetruefalsefalsetruefalsefalseNONEfalsefalsebatch.sizeBatch SizeThe 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.10truefalsefalseNONEfalsefalseprefetch.countPrefetch CountThe maximum number of unacknowledged messages for the consumer. If consumer has this number of unacknowledged messages, AMQP broker will no longer send new messages until consumer acknowledges some of the messages already delivered to it.Allowed values: from 0 to 65535. 0 means no limit0truefalsefalseNONEfalsefalseheader.formatHeader Output FormatDefines how to output headers from the received messageComma-Separated StringComma-Separated StringComma-Separated StringPut all headers as a string with the specified separator in the attribute 'amqp$headers'.JSON StringJSON StringFormat all headers as JSON string and output in the attribute 'amqp$headers'. It will include keys with null value as well.FlowFile AttributesFlowFile AttributesPut each header as attribute of the flow file with a prefix specified in the propertiestruefalsefalseNONEfalsefalseheader.key.prefixHeader Key PrefixText to be prefixed to header keys as the are added to the FlowFile attributes. Processor will append '.' to the value of this propertyconsume.amqptruefalsefalseNONEfalsefalseheader.formatHeader Output FormatFlowFile Attributesheader.separatorHeader SeparatorThe character that is used to separate key-value for header in String. The value must be only one character.,falsefalsefalseNONEfalsefalseheader.formatHeader Output FormatComma-Separated Stringremove.curly.bracesRemove Curly BracesIf true Remove Curly Braces, Curly Braces in the header will be automatically remove.FalseTrueTrueFalseFalsefalsefalsefalseNONEfalsefalseheader.formatHeader Output FormatComma-Separated StringMax Inbound Message Body SizeMax Inbound Message Body SizeMaximum body size of inbound (received) messages.64 MBtruefalsetrueENVIRONMENTfalsefalseBrokersBrokersA comma-separated list of known AMQP Brokers in the format <host>:<port> (e.g., localhost:5672). If this is set, Host Name and Port are ignored. Only include hosts from the same AMQP cluster.falsefalsetrueENVIRONMENTfalsefalseHost NameHost NameNetwork address of AMQP broker (e.g., localhost). If Brokers is set, then this property is ignored.localhostfalsefalsetrueENVIRONMENTfalsefalsePortPortNumeric value identifying Port of AMQP broker (e.g., 5671). If Brokers is set, then this property is ignored.5672falsefalsetrueENVIRONMENTfalsefalseVirtual HostVirtual HostVirtual Host name which segregates AMQP system for enhanced security.falsefalsetrueENVIRONMENTfalsefalseUsernameUsernameUsername used for authentication and authorization.falsefalsetrueENVIRONMENTfalsefalsePasswordPasswordPassword used for authentication and authorization.falsetruefalseNONEfalsefalseAMQP VersionAMQP VersionAMQP Version. Currently only supports AMQP v0.9.1.0.9.10.9.10.9.1truefalsefalseNONEfalsefalseSSL Context ServiceSSL Context ServiceThe SSL Context Service used to provide client certificate information for TLS/SSL connections.org.apache.nifi.ssl.SSLContextProviderorg.apache.nifinifi-standard-services-api-nar2.4.0falsefalsefalseNONEfalsefalseClient Certificate Authentication EnabledClient Certificate Authentication EnabledAuthenticate using the SSL certificate rather than user name/password.falsetruetruefalsefalsefalsefalsefalseNONEfalsefalsesuccessAll FlowFiles that are received from the AMQP queue are routed to this relationshipfalseamqp$appIdThe App ID field from the AMQP Messageamqp$contentEncodingThe Content Encoding reported by the AMQP Messageamqp$contentTypeThe Content Type reported by the AMQP Messageamqp$headersThe headers present on the AMQP Message. Added only if processor is configured to output this attribute.<Header Key Prefix>.<attribute>Each message header will be inserted with this attribute name, if processor is configured to output headers as attributeamqp$deliveryModeThe numeric indicator for the Message's Delivery Modeamqp$priorityThe Message priorityamqp$correlationIdThe Message's Correlation IDamqp$replyToThe value of the Message's Reply-To fieldamqp$expirationThe Message Expirationamqp$messageIdThe unique ID of the Messageamqp$timestampThe timestamp of the Message, as the number of milliseconds since epochamqp$typeThe type of messageamqp$userIdThe ID of the useramqp$clusterIdThe ID of the AMQP Clusteramqp$routingKeyThe routingKey of the AMQP Messageamqp$exchangeThe exchange from which AMQP Message was receivedINPUT_FORBIDDENorg.apache.nifi.amqp.processors.PublishAMQPPROCESSORCreates an AMQP Message from the contents of a FlowFile and sends the message to an AMQP Exchange. In a typical AMQP exchange model, the message that is sent to the AMQP Exchange will be routed based on the 'Routing Key' to its final destination in the queue (the binding). If due to some misconfiguration the binding between the Exchange, Routing Key and Queue is not set up, the message will have no final destination and will return (i.e., the data will not make it to the queue). If that happens you will see a log in both app-log and bulletin stating to that effect, and the FlowFile will be routed to the 'failure' relationship.amqprabbitputmessagesendpublishExchange NameExchange NameThe name of the AMQP Exchange the messages will be sent to. Usually provided by the AMQP administrator (e.g., 'amq.direct'). It is an optional property. If kept empty the messages will be sent to a default AMQP exchange.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseRouting KeyRouting KeyThe name of the Routing Key that will be used by AMQP to route messages from the exchange to a destination queue(s). Usually provided by the administrator (e.g., 'myKey')In the event when messages are sent to a default exchange this property corresponds to a destination queue name, otherwise a binding from the Exchange to a Queue via Routing Key must be set (usually by the AMQP administrator)truefalsetrueFLOWFILE_ATTRIBUTESfalsefalseHeaders SourceHeaders SourceThe source of the headers which will be applied to the published message.AMQP_HEADERS_ATTRIBUTEFlowFile AttributesFLOWFILE_ATTRIBUTESSelect FlowFile Attributes based on regular expression pattern for event headers. Key of the matching attribute will be used as header keyAMQP Headers AttributeAMQP_HEADERS_ATTRIBUTEPrepare headers from 'amqp$headers' attribute stringtruefalsefalseNONEfalsefalseHeaders PatternHeaders PatternRegular expression that will be evaluated against the FlowFile attributes to select the matching attributes and put as AMQP headers. Attribute name will be used as header key.truefalsetrueENVIRONMENTfalsefalseHeaders SourceHeaders SourceFLOWFILE_ATTRIBUTESheader.separatorHeader SeparatorThe character that is used to split key-value for headers. The value must only one character. Otherwise you will get an error message,falsefalsefalseNONEfalsefalseHeaders SourceHeaders SourceAMQP_HEADERS_ATTRIBUTEBrokersBrokersA comma-separated list of known AMQP Brokers in the format <host>:<port> (e.g., localhost:5672). If this is set, Host Name and Port are ignored. Only include hosts from the same AMQP cluster.falsefalsetrueENVIRONMENTfalsefalseHost NameHost NameNetwork address of AMQP broker (e.g., localhost). If Brokers is set, then this property is ignored.localhostfalsefalsetrueENVIRONMENTfalsefalsePortPortNumeric value identifying Port of AMQP broker (e.g., 5671). If Brokers is set, then this property is ignored.5672falsefalsetrueENVIRONMENTfalsefalseVirtual HostVirtual HostVirtual Host name which segregates AMQP system for enhanced security.falsefalsetrueENVIRONMENTfalsefalseUsernameUsernameUsername used for authentication and authorization.falsefalsetrueENVIRONMENTfalsefalsePasswordPasswordPassword used for authentication and authorization.falsetruefalseNONEfalsefalseAMQP VersionAMQP VersionAMQP Version. Currently only supports AMQP v0.9.1.0.9.10.9.10.9.1truefalsefalseNONEfalsefalseSSL Context ServiceSSL Context ServiceThe SSL Context Service used to provide client certificate information for TLS/SSL connections.org.apache.nifi.ssl.SSLContextProviderorg.apache.nifinifi-standard-services-api-nar2.4.0falsefalsefalseNONEfalsefalseClient Certificate Authentication EnabledClient Certificate Authentication EnabledAuthenticate using the SSL certificate rather than user name/password.falsetruetruefalsefalsefalsefalsefalseNONEfalsefalsefailureAll FlowFiles that cannot be routed to the AMQP destination are routed to this relationshipfalsesuccessAll FlowFiles that are sent to the AMQP destination are routed to this relationshipfalseamqp$appIdThe App ID field to set on the AMQP Messageamqp$contentEncodingThe Content Encoding to set on the AMQP Messageamqp$contentTypeThe Content Type to set on the AMQP Messageamqp$headersThe headers to set on the AMQP Message, if 'Header Source' is set to use it. See additional details of the processor.amqp$deliveryModeThe numeric indicator for the Message's Delivery Modeamqp$priorityThe Message priorityamqp$correlationIdThe Message's Correlation IDamqp$replyToThe value of the Message's Reply-To fieldamqp$expirationThe Message Expirationamqp$messageIdThe unique ID of the Messageamqp$timestampThe timestamp of the Message, as the number of milliseconds since epochamqp$typeThe type of messageamqp$userIdThe ID of the useramqp$clusterIdThe ID of the AMQP ClusterINPUT_REQUIREDMEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.