| {"component":{"kind":"component","name":"azure-servicebus","title":"Azure ServiceBus","description":"Send and receive messages to/from Azure Event Bus.","deprecated":false,"firstVersion":"3.12.0","label":"cloud,messaging","javaType":"org.apache.camel.component.azure.servicebus.ServiceBusComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-azure-servicebus","version":"3.18.1","scheme":"azure-servicebus","extendsScheme":"","syntax":"azure-servicebus:topicOrQueueName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelAzureServiceBusApplicationProperties":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Map<String, Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the set of free-form ServiceBusReceivedMessage properties which may be used for passing metadata associated with the ServiceBusReceivedMessagel during Service Bus operations.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#APPLICATION_PROPERTIES"},"CamelAzureServiceBusContentType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the content type of the message.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#CONTENT_TYPE"},"CamelAzureServiceBusCorrelationId":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets a correlation identifier.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#CORRELATION_ID"},"CamelAzureServiceBusDeadLetterErrorDescription":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the description for a message that has been dead-lettered.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#DEAD_LETTER_ERROR_DESCRIPTION"},"CamelAzureServiceBusDeadLetterReason":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the reason a message was dead-lettered.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#DEAD_LETTER_REASON"},"CamelAzureServiceBusDeadLetterSource":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the name of the queue or subscription that this message was enqueued on, before it was dead-lettered.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#DEAD_LETTER_SOURCE"},"CamelAzureServiceBusDeliveryCount":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the number of the times this message was delivered to clients.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#DELIVERY_COUNT"},"CamelAzureServiceBusEnqueuedSequenceNumber":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the enqueued sequence number assigned to a message by Service Bus.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#ENQUEUED_SEQUENCE_NUMBER"},"CamelAzureServiceBusEnqueuedTime":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the datetime at which this message was enqueued in Azure Service Bus.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#ENQUEUED_TIME"},"CamelAzureServiceBusExpiresAt":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the datetime at which this message will expire.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#EXPIRES_AT"},"CamelAzureServiceBusLockToken":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the lock token for the current message.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#LOCK_TOKEN"},"CamelAzureServiceBusLockedUntil":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the datetime at which the lock of this message expires.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#LOCKED_UNTIL"},"CamelAzureServiceBusMessageId":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the identifier for the message.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#MESSAGE_ID"},"CamelAzureServiceBusPartitionKey":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the partition key for sending a message to a partitioned entity.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#PARTITION_KEY"},"CamelAzureServiceBusRawAmqpMessage":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"AmqpAnnotatedMessage","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The representation of message as defined by AMQP protocol.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#RAW_AMQP_MESSAGE"},"CamelAzureServiceBusReplyTo":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the address of an entity to send replies to.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#REPLY_TO"},"CamelAzureServiceBusReplyToSessionId":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets or sets a session identifier augmenting the ReplyTo address.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#REPLY_TO_SESSION_ID"},"CamelAzureServiceBusSequenceNumber":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the unique number assigned to a message by Service Bus.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#SEQUENCE_NUMBER"},"CamelAzureServiceBusSessionId":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the session id of the message.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#SESSION_ID"},"CamelAzureServiceBusSubject":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the subject for the message.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#SUBJECT"},"CamelAzureServiceBusTimeToLive":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Duration","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the duration before this message expires.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#TIME_TO_LIVE"},"CamelAzureServiceBusTo":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Gets the to address.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#TO"},"CamelAzureServiceBusScheduledEnqueueTime":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"OffsetDateTime","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"(producer)Overrides the OffsetDateTime at which the message should appear in the Service Bus queue or topic. (consumer) Gets the scheduled enqueue time of this message.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#SCHEDULED_ENQUEUE_TIME"},"CamelAzureServiceBusServiceBusTransactionContext":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"ServiceBusTransactionContext","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Overrides the transaction in service. This object just contains transaction id.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#SERVICE_BUS_TRANSACTION_CONTEXT"},"CamelAzureServiceBusProducerOperation":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition","enum":["sendMessages","scheduleMessages"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Overrides the desired operation to be used in the producer.","constantName":"org.apache.camel.component.azure.servicebus.ServiceBusConstants#PRODUCER_OPERATION"}},"properties":{"topicOrQueueName":{"kind":"path","displayName":"Topic Or Queue Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Selected topic name or the queue name, that is depending on serviceBusType config. For example if serviceBusType=queue, then this will be the queue name and if serviceBusType=topic, this will be the topic name."},"amqpRetryOptions":{"kind":"parameter","displayName":"Amqp Retry Options","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.core.amqp.AmqpRetryOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the retry options for Service Bus clients. If not specified, the default retry options are used."},"amqpTransportType":{"kind":"parameter","displayName":"Amqp Transport Type","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.core.amqp.AmqpTransportType","enum":["Amqp","AmqpWebSockets"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"AMQP","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType#AMQP."},"clientOptions":{"kind":"parameter","displayName":"Client Options","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.core.util.ClientOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. Refer to the ClientOptions documentation for more information."},"proxyOptions":{"kind":"parameter","displayName":"Proxy Options","group":"common","label":"common","required":false,"type":"object","javaType":"com.azure.core.amqp.ProxyOptions","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type."},"serviceBusType":{"kind":"parameter","displayName":"Service Bus Type","group":"common","label":"common","required":true,"type":"object","javaType":"org.apache.camel.component.azure.servicebus.ServiceBusType","enum":["queue","topic"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"queue","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model."},"consumerOperation":{"kind":"parameter","displayName":"Consumer Operation","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition","enum":["receiveMessages","peekMessages"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"receiveMessages","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the desired operation to be used in the consumer"},"disableAutoComplete":{"kind":"parameter","displayName":"Disable Auto Complete","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is {link ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}. If an error happens when the message is processed, it is {link ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}."},"maxAutoLockRenewDuration":{"kind":"parameter","displayName":"Max Auto Lock Renew Duration","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"java.time.Duration","deprecated":false,"autowired":false,"secret":false,"defaultValue":"5m","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the amount of time to continue auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal. For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode, auto-renewal is disabled."},"peekNumMaxMessages":{"kind":"parameter","displayName":"Peek Num Max Messages","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Set the max number of messages to be peeked during the peek operation."},"prefetchCount":{"kind":"parameter","displayName":"Prefetch Count","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the prefetch count of the receiver. For both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off."},"receiverAsyncClient":{"kind":"parameter","displayName":"Receiver Async Client","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the receiverAsyncClient in order to consume messages by the consumer"},"serviceBusReceiveMode":{"kind":"parameter","displayName":"Service Bus Receive Mode","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.models.ServiceBusReceiveMode","enum":["PEEK_LOCK","RECEIVE_AND_DELETE"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"PEEK_LOCK","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the receive mode for the receiver."},"subQueue":{"kind":"parameter","displayName":"Sub Queue","group":"consumer","label":"consumer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.models.SubQueue","enum":["NONE","DEAD_LETTER_QUEUE","TRANSFER_DEAD_LETTER_QUEUE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the type of the SubQueue to connect to."},"subscriptionName":{"kind":"parameter","displayName":"Subscription Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set. This property is required if serviceBusType=topic and the consumer is in use."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"producerOperation":{"kind":"parameter","displayName":"Producer Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition","enum":["sendMessages","scheduleMessages"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"sendMessages","configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the desired operation to be used in the producer"},"scheduledEnqueueTime":{"kind":"parameter","displayName":"Scheduled Enqueue Time","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.time.OffsetDateTime","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic."},"senderAsyncClient":{"kind":"parameter","displayName":"Sender Async Client","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusSenderAsyncClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets SenderAsyncClient to be used in the producer."},"serviceBusTransactionContext":{"kind":"parameter","displayName":"Service Bus Transaction Context","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.azure.messaging.servicebus.ServiceBusTransactionContext","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Represents transaction in service. This object just contains transaction id."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."},"connectionString":{"kind":"parameter","displayName":"Connection String","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Sets the connection string for a Service Bus namespace or a specific Service Bus resource."},"fullyQualifiedNamespace":{"kind":"parameter","displayName":"Fully Qualified Namespace","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"Fully Qualified Namespace of the service bus"},"tokenCredential":{"kind":"parameter","displayName":"Token Credential","group":"security","label":"security","required":false,"type":"object","javaType":"com.azure.core.credential.TokenCredential","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.azure.servicebus.ServiceBusConfiguration","configurationField":"configuration","description":"A TokenCredential for Azure AD authentication, implemented in com.azure.identity"}}} |