RabbitMQ Consumer Properties

The acknowledge mode.

When the binding has no group property, an anonymous, auto-delete queue is bound to the destination exchange. The default naming stragegy for such queues results in a queue named anonymous.<base64 representation of a UUID>. Set this property to change the prefix to something other than the default.

Whether to automatically declare the DLQ and bind it to the binder DLX.

The routing key with which to bind the queue to the exchange (if bindQueue is true). Can be multiple keys - see bindingRoutingKeyDelimiter. For partitioned destinations, -<instanceIndex> is appended to each key.

When this is not null, 'bindingRoutingKey' is considered to be a list of keys delimited by this value; often a comma is used.

Whether to declare the queue and bind it to the destination exchange. Set it to false if you have set up your own infrastructure and have previously created and bound the queue.

Used to create the consumer tag(s); will be appended by #n where n increments for each consumer created. Example: ${spring.application.name}-${spring.cloud.stream.bindings.input.group}-${spring.cloud.stream.instance-index}.

Select the type of listener container to be used. See Choosing a Container in the Spring AMQP documentation for more information. Also see [rabbitmq-stream].

The name of the DLQ

A DLX to assign to the queue. Relevant only if autoBindDlq is true.

The type of the DLX to assign to the queue. Relevant only if autoBindDlq is true.

A dead letter routing key to assign to the queue. Relevant only if autoBindDlq is true.

Whether to declare the dead letter exchange for the destination. Relevant only if autoBindDlq is true. Set to false if you have a pre-configured DLX.

Whether to declare the exchange for the destination.

Whether to declare the exchange as a Delayed Message Exchange. Requires the delayed message exchange plugin on the broker. The x-delayed-type argument is set to the exchangeType.

Arguments applied when binding the dlq to the dead letter exchange; used with headers deadLetterExchangeType to specify headers to match on. For example …​dlqBindingArguments.x-match=any, …​dlqBindingArguments.someHeader=someValue.

If a DLQ is declared, a DLX to assign to that queue.

If a DLQ is declared, a dead letter routing key to assign to that queue.

How long before an unused dead letter queue is deleted (in milliseconds).

Declare the dead letter queue with the x-queue-mode=lazy argument. See “Lazy Queues”. Consider using a policy instead of this setting, because using a policy allows changing the setting without deleting the queue.

Maximum number of messages in the dead letter queue.

Maximum number of total bytes in the dead letter queue from all messages.

Maximum priority of messages in the dead letter queue (0-255).

Action to take when dlqMaxLength or dlqMaxLengthBytes is exceeded; currently drop-head or reject-publish but refer to the RabbitMQ documentation.

When quorum.enabled=true, set a delivery limit after which the message is dropped or dead-lettered.

When true, create a quorum dead letter queue instead of a classic queue.

When quorum.enabled=true, set the initial quorum size.

Set to true to set the x-single-active-consumer queue property to true.

Default time to live to apply to the dead letter queue when declared (in milliseconds).

Whether the subscription should be durable. Only effective if group is also set.

If declareExchange is true, whether the exchange should be auto-deleted (that is, removed after the last queue is removed).

If declareExchange is true, whether the exchange should be durable (that is, it survives broker restart).

The exchange type: direct, fanout, headers or topic for non-partitioned destinations and direct, headers or topic for partitioned destinations.

Whether to create an exclusive consumer. Concurrency should be 1 when this is true. Often used when strict ordering is required but enabling a hot standby instance to take over after a failure. See recoveryInterval, which controls how often a standby instance attempts to consume. Consider using singleActiveConsumer instead when using RabbitMQ 3.8 or later.

How long before an unused queue is deleted (in milliseconds).

The interval (in milliseconds) between attempts to consume from a queue if it is missing.

The number of bytes to reserve for other headers when adding the stack trace to a DLQ message header. All headers must fit within the frame_max size configured on the broker. Stack traces can be large; if the size plus this property exceeds frame_max then the stack trace will be truncated. A WARN log will be written; consider increasing the frame_max or reducing the stack trace by catching the exception and throwing one with a smaller stack trace.

Patterns for headers to be mapped from inbound messages.

Declare the queue with the x-queue-mode=lazy argument. See “Lazy Queues”. Consider using a policy instead of this setting, because using a policy allows changing the setting without deleting the queue.

The maximum number of consumers. Not supported when the containerType is direct.

The maximum number of messages in the queue.

The maximum number of total bytes in the queue from all messages.

The maximum priority of messages in the queue (0-255).

When the queue cannot be found, whether to treat the condition as fatal and stop the listener container. Defaults to false so that the container keeps trying to consume from the queue — for example, when using a cluster and the node hosting a non-HA queue is down.

Action to take when maxLength or maxLengthBytes is exceeded; currently drop-head or reject-publish but refer to the RabbitMQ documentation.

Prefetch count.

A prefix to be added to the name of the destination and queues.

Arguments applied when binding the queue to the exchange; used with headers exchangeType to specify headers to match on. For example …​queueBindingArguments.x-match=any, …​queueBindingArguments.someHeader=someValue.

The number of times to retry consuming from a queue if it is missing. Relevant only when missingQueuesFatal is true. Otherwise, the container keeps retrying indefinitely. Not supported when the containerType is direct.

When true, consume from a queue with a name equal to the group. Otherwise the queue name is destination.group. This is useful, for example, when using Spring Cloud Stream to consume from an existing RabbitMQ queue.

When quorum.enabled=true, set a delivery limit after which the message is dropped or dead-lettered.

When true, create a quorum queue instead of a classic queue.

When quorum.enabled=true, set the initial quorum size.

The interval between connection recovery attempts, in milliseconds.

Whether delivery failures should be re-queued when retry is disabled or republishToDlq is false.

When republishToDlq is true, specifies the delivery mode of the republished message.

By default, messages that fail after retries are exhausted are rejected. If a dead-letter queue (DLQ) is configured, RabbitMQ routes the failed message (unchanged) to the DLQ. If set to true, the binder republishs failed messages to the DLQ with additional headers, including the exception message and stack trace from the cause of the final failure. Also see the frameMaxHeadroom property.

Set to true to set the x-single-active-consumer queue property to true.

Whether to use transacted channels.

Default time to live to apply to the queue when declared (in milliseconds).

The number of deliveries between acks. Not supported when the containerType is direct.